From 69691c5a8242677da1487756638c2a6d8ab9ca8d Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Tue, 14 Oct 2025 20:38:53 -0700 Subject: [PATCH] clean up bug reports and feature requests doc --- .../feature-requests-and-bug-reports.mdx | 114 ------------------ 1 file changed, 114 deletions(-) diff --git a/development/feature-requests-and-bug-reports.mdx b/development/feature-requests-and-bug-reports.mdx index e69d2d7..118346b 100644 --- a/development/feature-requests-and-bug-reports.mdx +++ b/development/feature-requests-and-bug-reports.mdx @@ -17,10 +17,6 @@ We welcome contributions from the community to help improve Pangolin. To ensure ## Feature Requests - -**Use GitHub Discussions**: [Pangolin Discussions](https://github.com/fosrl/pangolin/discussions) - - 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 @@ -28,58 +24,12 @@ We encourage you to submit feature requests in the [GitHub Discussions section]( - **Discuss implementation details** and alternatives - **Help prioritize** which features to work on next -### How to Submit a Feature Request - - - - Search the [Discussions section](https://github.com/fosrl/pangolin/discussions) to see if your feature has already been requested. - - - - Click "New discussion" and select "Feature Requests" or "Ideas" as the category. - - - - Include: - - Clear description of the feature - - Use case and benefits - - Any implementation ideas - - Screenshots or mockups if applicable - - - - Respond to comments and help refine the feature proposal. - - - -### Feature Request Template - -```markdown -## Feature Request: [Brief Description] - -### What problem does this solve? -[Describe the problem or limitation this feature would address] - -### Proposed solution -[Describe how this feature would work] - -### Use cases -[Describe specific scenarios where this would be useful] - -### Additional context -[Any other relevant information, screenshots, or examples] -``` - Feature requests with community support (upvotes and positive feedback) are more likely to be prioritized for development. ## Bug Reports - -**Use GitHub Issues**: [Pangolin Issues](https://github.com/fosrl/pangolin/issues) - - Bug reports should be submitted in the [GitHub Issues section](https://github.com/fosrl/pangolin/issues) for proper tracking and resolution. This ensures: - **Proper tracking** of bugs through their lifecycle @@ -87,73 +37,17 @@ Bug reports should be submitted in the [GitHub Issues section](https://github.co - **Version tracking** and regression testing - **Duplicate detection** and consolidation -### How to Submit a Bug Report - - - - Search the [Issues section](https://github.com/fosrl/pangolin/issues) to see if the bug has already been reported. - - - - Click "New issue" and select "Bug report" as the template. - - - - Provide all requested information including: - - Steps to reproduce - - Expected vs actual behavior - - Environment details - - Error messages or logs - - - - Use appropriate labels to help categorize the issue. - - - -### Bug Report Template - -```markdown -## Bug Description -[Brief description of the bug] - -## Steps to Reproduce -1. [First step] -2. [Second step] -3. [Third step] - -## Expected Behavior -[What should happen] - -## Actual Behavior -[What actually happens] - -## Environment -- **Pangolin Version**: [version] -- **OS**: [operating system] -- **Browser**: [if applicable] -- **Docker Version**: [if using Docker] - -## Error Messages -[Any error messages or logs] - -## Additional Context -[Screenshots, configuration files, or other relevant information] -``` - Please provide as much detail as possible to help developers reproduce and fix the issue quickly. ## 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 @@ -166,11 +60,3 @@ Please provide as much detail as possible to help developers reproduce and fix t 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://digpangolin.com/discord). - -## Contributing Code - -If you'd like to implement a feature or fix a bug yourself, please see our [Development Guide](/development/contributing) for setup instructions and coding guidelines. - - -We appreciate all contributions, whether they're feature requests, bug reports, or code contributions. Your feedback helps make Pangolin better for everyone. -