CONTRIBUTING.md•1.64 kB
# Contributing to OPNsense MCP Server
Thank you for considering contributing to the OPNsense MCP Server project! We welcome contributions from the community.
## How Can I Contribute?
### Reporting Bugs
- Ensure the bug was not already reported by searching on the issue tracker.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample or an executable test case** demonstrating the expected behavior that is not occurring.
- Clearly describe the steps to reproduce the bug.
### Suggesting Enhancements
- Open a new issue on the issue tracker.
- Clearly describe the enhancement and the motivation for it.
- Explain why this enhancement would be useful.
- Provide code examples if possible.
### Pull Requests
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeature` or `bugfix/YourBugfix`).
3. Make your changes. Adhere to the existing code style.
4. Add tests for your changes if applicable.
5. Ensure your code passes any existing tests.
6. Commit your changes (`git commit -am 'Add some feature'`). Use clear and descriptive commit messages.
7. Push to the branch (`git push origin feature/YourFeature`).
8. Create a new Pull Request.
- Provide a clear description of the problem and solution.
- Link to any relevant issues.
## Code Style
Please adhere to standard Python coding conventions (PEP 8). Ensure your code is well-commented where necessary.
## Questions?
If you have questions about contributing, feel free to open an issue and ask.