Thanks for taking an interest in contributing to BirchRest! Any help, whether it's fixing a bug, adding a feature, or reporting an issue, is greatly appreciated.
Pull requests are welcome! If you’ve made improvements or fixed something, here’s how to submit a pull request:
- Fork the repository and create a new branch (
git checkout -b feature/your-feature). - Commit your changes (
git commit -m 'Add a new feature'). - Push your changes (
git push origin feature/your-feature). - Open a pull request and describe what you’ve changed.
If you find a problem that you can’t solve yourself or don’t have time to work on, feel free to open an issue. Please provide as much detail as you can, including steps to reproduce the issue and any logs or error messages. Suggestions and discussions on potential solutions are always welcome!
When you submit a pull request, some automated checks will run. These checks need to pass before the pull request can be merged:
- Unit Tests: All unit tests will run on different Python versions (>=3.8) across various operating systems (Windows, macOS, and Linux). This ensures everything works as expected in different environments.
- Code Coverage: The project requires at least 80% code coverage. If the tests don't cover enough of the code, the pull request will fail.
- Type Checking: mypy will check the code for correct type annotations. The pull request must pass this check.
- Linting: pylint will check the code style. If the code doesn’t meet the style requirements, the pull request will need to be updated. The codebase needs to score at least 9/10 on the pylint test to pass.
- Security Checks: bandit will run to check the code for common security vulnerabilities, and safety will check for known vulnerabilities in the dependencies. The pull request will fail if any critical security issues are found.