From 09dad9c4db42dc15f64918bfeec8227b9178eda1 Mon Sep 17 00:00:00 2001 From: Laurence Date: Mon, 9 Feb 2026 10:37:03 +0000 Subject: [PATCH] enhance(development): improve issue-report routing by component Clarify where users should file feature requests and bug reports across Pangolin, Newt, Gerbil, and Olm to improve direction and reduce misfiled issues. --- .../feature-requests-and-bug-reports.mdx | 35 +++++++++++++++---- 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/development/feature-requests-and-bug-reports.mdx b/development/feature-requests-and-bug-reports.mdx index a08a32c..4a22b66 100644 --- a/development/feature-requests-and-bug-reports.mdx +++ b/development/feature-requests-and-bug-reports.mdx @@ -3,15 +3,31 @@ title: "Feature Requests & Bug Reports" description: "How to submit feature requests and report bugs for Pangolin" --- -We welcome contributions from the community to help improve Pangolin. To ensure your feedback is properly tracked and prioritized, please use the appropriate GitHub sections for different types of submissions. +We welcome contributions from the community to help improve Pangolin. To ensure your feedback is properly tracked and prioritized, use the repository that matches the component where your issue or request belongs. + +## Pick the Right Repository + +Pangolin is made up of multiple components. To get the fastest response, file your request or bug report in the repository that matches the component you're using. - - Submit in GitHub Discussions for community feedback and upvoting + + Dashboard and core platform. + [Discussions](https://github.com/fosrl/pangolin/discussions) and [Issues](https://github.com/fosrl/pangolin/issues). - - Submit in GitHub Issues for tracking and resolution + + Site and network connector. + [Issues](https://github.com/fosrl/newt/issues). + + + + WireGuard interface management service. + [Issues](https://github.com/fosrl/gerbil/issues). + + + + Client tunnel connector for Newt sites. + [Issues](https://github.com/fosrl/olm/issues). @@ -30,7 +46,14 @@ Feature requests with community support (upvotes and positive feedback) are more ## Bug Reports -Bug reports should be submitted in the [GitHub Issues section](https://github.com/fosrl/pangolin/issues) for proper tracking and resolution. This ensures: +Bug reports should be submitted in GitHub Issues for the relevant repository: + +- **Pangolin**: [fosrl/pangolin/issues](https://github.com/fosrl/pangolin/issues) +- **Newt**: [fosrl/newt/issues](https://github.com/fosrl/newt/issues) +- **Gerbil**: [fosrl/gerbil/issues](https://github.com/fosrl/gerbil/issues) +- **Olm**: [fosrl/olm/issues](https://github.com/fosrl/olm/issues) + +Using the correct repo ensures: - **Proper tracking** of bugs through their lifecycle - **Developer visibility** for quick resolution