mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-03-02 00:36:45 +00:00
Merge branch 'main' into enterprise
This commit is contained in:
miloschwartz
@@ -17,10 +17,6 @@ We welcome contributions from the community to help improve Pangolin. To ensure
|
|||||||
|
|
||||||
## Feature Requests
|
## Feature Requests
|
||||||
|
|
||||||
<Info>
|
|
||||||
**Use GitHub Discussions**: [Pangolin Discussions](https://github.com/fosrl/pangolin/discussions)
|
|
||||||
</Info>
|
|
||||||
|
|
||||||
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:
|
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
|
- **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
|
- **Discuss implementation details** and alternatives
|
||||||
- **Help prioritize** which features to work on next
|
- **Help prioritize** which features to work on next
|
||||||
|
|
||||||
### How to Submit a Feature Request
|
|
||||||
|
|
||||||
<Steps>
|
|
||||||
<Step title="Check existing discussions">
|
|
||||||
Search the [Discussions section](https://github.com/fosrl/pangolin/discussions) to see if your feature has already been requested.
|
|
||||||
</Step>
|
|
||||||
|
|
||||||
<Step title="Create a new discussion">
|
|
||||||
Click "New discussion" and select "Feature Requests" or "Ideas" as the category.
|
|
||||||
</Step>
|
|
||||||
|
|
||||||
<Step title="Provide details">
|
|
||||||
Include:
|
|
||||||
- Clear description of the feature
|
|
||||||
- Use case and benefits
|
|
||||||
- Any implementation ideas
|
|
||||||
- Screenshots or mockups if applicable
|
|
||||||
</Step>
|
|
||||||
|
|
||||||
<Step title="Engage with community">
|
|
||||||
Respond to comments and help refine the feature proposal.
|
|
||||||
</Step>
|
|
||||||
</Steps>
|
|
||||||
|
|
||||||
### 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]
|
|
||||||
```
|
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
Feature requests with community support (upvotes and positive feedback) are more likely to be prioritized for development.
|
Feature requests with community support (upvotes and positive feedback) are more likely to be prioritized for development.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
## Bug Reports
|
## Bug Reports
|
||||||
|
|
||||||
<Warning>
|
|
||||||
**Use GitHub Issues**: [Pangolin Issues](https://github.com/fosrl/pangolin/issues)
|
|
||||||
</Warning>
|
|
||||||
|
|
||||||
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 the [GitHub Issues section](https://github.com/fosrl/pangolin/issues) for proper tracking and resolution. This ensures:
|
||||||
|
|
||||||
- **Proper tracking** of bugs through their lifecycle
|
- **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
|
- **Version tracking** and regression testing
|
||||||
- **Duplicate detection** and consolidation
|
- **Duplicate detection** and consolidation
|
||||||
|
|
||||||
### How to Submit a Bug Report
|
|
||||||
|
|
||||||
<Steps>
|
|
||||||
<Step title="Check existing issues">
|
|
||||||
Search the [Issues section](https://github.com/fosrl/pangolin/issues) to see if the bug has already been reported.
|
|
||||||
</Step>
|
|
||||||
|
|
||||||
<Step title="Create a new issue">
|
|
||||||
Click "New issue" and select "Bug report" as the template.
|
|
||||||
</Step>
|
|
||||||
|
|
||||||
<Step title="Fill out the template">
|
|
||||||
Provide all requested information including:
|
|
||||||
- Steps to reproduce
|
|
||||||
- Expected vs actual behavior
|
|
||||||
- Environment details
|
|
||||||
- Error messages or logs
|
|
||||||
</Step>
|
|
||||||
|
|
||||||
<Step title="Add labels">
|
|
||||||
Use appropriate labels to help categorize the issue.
|
|
||||||
</Step>
|
|
||||||
</Steps>
|
|
||||||
|
|
||||||
### 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]
|
|
||||||
```
|
|
||||||
|
|
||||||
<Warning>
|
<Warning>
|
||||||
Please provide as much detail as possible to help developers reproduce and fix the issue quickly.
|
Please provide as much detail as possible to help developers reproduce and fix the issue quickly.
|
||||||
</Warning>
|
</Warning>
|
||||||
|
|
||||||
## Before Submitting
|
## Before Submitting
|
||||||
|
|
||||||
<Check>
|
|
||||||
- Search existing discussions and issues to avoid duplicates
|
- Search existing discussions and issues to avoid duplicates
|
||||||
- Provide clear, detailed information
|
- Provide clear, detailed information
|
||||||
- Include steps to reproduce (for bugs)
|
- Include steps to reproduce (for bugs)
|
||||||
- Test on the latest version of Pangolin
|
- Test on the latest version of Pangolin
|
||||||
- Check if the issue is environment-specific
|
- Check if the issue is environment-specific
|
||||||
</Check>
|
|
||||||
|
|
||||||
## Alternative Channels
|
## 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).
|
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).
|
||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
<Note>
|
|
||||||
We appreciate all contributions, whether they're feature requests, bug reports, or code contributions. Your feedback helps make Pangolin better for everyone.
|
|
||||||
</Note>
|
|
||||||
|
|||||||
Reference in New Issue
Block a user