From 09dad9c4db42dc15f64918bfeec8227b9178eda1 Mon Sep 17 00:00:00 2001 From: Laurence Date: Mon, 9 Feb 2026 10:37:03 +0000 Subject: [PATCH 1/3] 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 From c5f04936b5f40b308a2be1f12322a30b8ee84ff8 Mon Sep 17 00:00:00 2001 From: Laurence Date: Mon, 9 Feb 2026 19:49:44 +0000 Subject: [PATCH 2/3] docs: split server and user clients --- .../feature-requests-and-bug-reports.mdx | 39 ++++++++++++++++++- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/development/feature-requests-and-bug-reports.mdx b/development/feature-requests-and-bug-reports.mdx index 4a22b66..d1e9afa 100644 --- a/development/feature-requests-and-bug-reports.mdx +++ b/development/feature-requests-and-bug-reports.mdx @@ -7,7 +7,9 @@ We welcome contributions from the community to help improve Pangolin. To ensure ## 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. +Pangolin is made up of multiple components. To get the fastest response, file your request or bug report in the repository that matches what you're using. + +### Server Components @@ -24,9 +26,33 @@ Pangolin is made up of multiple components. To get the fastest response, file yo WireGuard interface management service. [Issues](https://github.com/fosrl/gerbil/issues). + + +### User Clients + + + + Pangolin desktop application for Windows. + [Issues](https://github.com/fosrl/windows/issues). + + + + Pangolin mobile application for Android. + [Issues](https://github.com/fosrl/android/issues). + + + + Pangolin application for macOS, iOS, and iPadOS. + [Issues](https://github.com/fosrl/apple/issues). + + + + Pangolin CLI client for Linux and macOS environments. + [Issues](https://github.com/fosrl/cli/issues). + - Client tunnel connector for Newt sites. + Low-level client tunnel connector used by clients. [Issues](https://github.com/fosrl/olm/issues). @@ -48,9 +74,18 @@ Feature requests with community support (upvotes and positive feedback) are more Bug reports should be submitted in GitHub Issues for the relevant repository: +### Server Components + - **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) + +### User Clients + +- **Windows App**: [fosrl/windows/issues](https://github.com/fosrl/windows/issues) +- **Android App**: [fosrl/android/issues](https://github.com/fosrl/android/issues) +- **Apple App**: [fosrl/apple/issues](https://github.com/fosrl/apple/issues) +- **Unix CLI**: [fosrl/cli/issues](https://github.com/fosrl/cli/issues) - **Olm**: [fosrl/olm/issues](https://github.com/fosrl/olm/issues) Using the correct repo ensures: From 4d5d9b32a865a78ff0b2a2e121596b4be881ae26 Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Mon, 9 Feb 2026 14:46:35 -0800 Subject: [PATCH 3/3] minor adjustments to naming --- development/feature-requests-and-bug-reports.mdx | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/development/feature-requests-and-bug-reports.mdx b/development/feature-requests-and-bug-reports.mdx index d1e9afa..b4bb058 100644 --- a/development/feature-requests-and-bug-reports.mdx +++ b/development/feature-requests-and-bug-reports.mdx @@ -41,20 +41,15 @@ Pangolin is made up of multiple components. To get the fastest response, file yo [Issues](https://github.com/fosrl/android/issues). - + Pangolin application for macOS, iOS, and iPadOS. [Issues](https://github.com/fosrl/apple/issues). - + Pangolin CLI client for Linux and macOS environments. [Issues](https://github.com/fosrl/cli/issues). - - - Low-level client tunnel connector used by clients. - [Issues](https://github.com/fosrl/olm/issues). - ## Feature Requests @@ -84,8 +79,8 @@ Bug reports should be submitted in GitHub Issues for the relevant repository: - **Windows App**: [fosrl/windows/issues](https://github.com/fosrl/windows/issues) - **Android App**: [fosrl/android/issues](https://github.com/fosrl/android/issues) -- **Apple App**: [fosrl/apple/issues](https://github.com/fosrl/apple/issues) -- **Unix CLI**: [fosrl/cli/issues](https://github.com/fosrl/cli/issues) +- **Apple Apps**: [fosrl/apple/issues](https://github.com/fosrl/apple/issues) +- **Pangolin CLI**: [fosrl/cli/issues](https://github.com/fosrl/cli/issues) - **Olm**: [fosrl/olm/issues](https://github.com/fosrl/olm/issues) Using the correct repo ensures: @@ -111,7 +106,7 @@ Please provide as much detail as possible to help developers reproduce and fix t - For security vulnerabilities, please email security@fossorial.com instead of posting publicly. + For security vulnerabilities, please email security@pangolin.net instead of posting publicly.