docs-v2/development/feature-requests-and-bug-reports.mdx

---
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.

<CardGroup cols={2}>
<Card title="Feature Requests" icon="lightbulb">
  Submit in GitHub Discussions for community feedback and upvoting
</Card>

<Card title="Bug Reports" icon="bug">
  Submit in GitHub Issues for tracking and resolution
</Card>
</CardGroup>

## 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:

- **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

### 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>
Feature requests with community support (upvotes and positive feedback) are more likely to be prioritized for development.
</Note>

## 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:

- **Proper tracking** of bugs through their lifecycle
- **Developer visibility** for quick resolution
- **Version tracking** and regression testing
- **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>
Please provide as much detail as possible to help developers reproduce and fix the issue quickly.
</Warning>

## Before Submitting

<Check>
- 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
</Check>

## 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://discord.gg/HCJR8Xhme4).
</Card>
</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>