mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-11 07:26:42 +00:00
09dad9c4db
Clarify where users should file feature requests and bug reports across Pangolin, Newt, Gerbil, and Olm to improve direction and reduce misfiled issues.
86 lines
3.2 KiB
Plaintext
86 lines
3.2 KiB
Plaintext
---
|
|
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, 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.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Pangolin" icon="server" href="https://github.com/fosrl/pangolin">
|
|
Dashboard and core platform.
|
|
[Discussions](https://github.com/fosrl/pangolin/discussions) and [Issues](https://github.com/fosrl/pangolin/issues).
|
|
</Card>
|
|
|
|
<Card title="Newt" icon="plug" href="https://github.com/fosrl/newt">
|
|
Site and network connector.
|
|
[Issues](https://github.com/fosrl/newt/issues).
|
|
</Card>
|
|
|
|
<Card title="Gerbil" icon="circle-nodes" href="https://github.com/fosrl/gerbil">
|
|
WireGuard interface management service.
|
|
[Issues](https://github.com/fosrl/gerbil/issues).
|
|
</Card>
|
|
|
|
<Card title="Olm" icon="desktop" href="https://github.com/fosrl/olm">
|
|
Client tunnel connector for Newt sites.
|
|
[Issues](https://github.com/fosrl/olm/issues).
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Feature Requests
|
|
|
|
We encourage you to submit feature requests in the [GitHub Discussions section](https://github.com/fosrl/pangolin/discussions) of the Pangolin repository. This allows the community to:
|
|
|
|
- **Upvote features** they want to see implemented
|
|
- **Provide feedback** and suggestions on proposed features
|
|
- **Discuss implementation details** and alternatives
|
|
- **Help prioritize** which features to work on next
|
|
|
|
<Note>
|
|
Feature requests with community support (upvotes and positive feedback) are more likely to be prioritized for development.
|
|
</Note>
|
|
|
|
## Bug Reports
|
|
|
|
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
|
|
- **Version tracking** and regression testing
|
|
- **Duplicate detection** and consolidation
|
|
|
|
<Warning>
|
|
Please provide as much detail as possible to help developers reproduce and fix the issue quickly.
|
|
</Warning>
|
|
|
|
## Before Submitting
|
|
|
|
- Search existing discussions and issues to avoid duplicates
|
|
- Provide clear, detailed information
|
|
- Include steps to reproduce (for bugs)
|
|
- Test on the latest version of Pangolin
|
|
- Check if the issue is environment-specific
|
|
|
|
## Alternative Channels
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Security Issues" icon="shield">
|
|
For security vulnerabilities, please email security@fossorial.com instead of posting publicly.
|
|
</Card>
|
|
|
|
<Card title="General Questions" icon="question">
|
|
For general questions, use [GitHub Discussions](https://github.com/fosrl/pangolin/discussions) with the "Q&A" category, or come chat with us on [Discord](https://pangolin.net/discord).
|
|
</Card>
|
|
</CardGroup>
|