Thank you for considering contributing to python-healthchecklib! This document outlines the guidelines for contributing to this project.
- Make sure you open an issue to discuss the changes you want to make before you start working on them. This will help you get feedback on your ideas and avoid wasting time on something that might not be merged.
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes. You can run it with
poetry run pytest. - Make sure your code lints.
- Submit a pull request.
This project uses black and isort to format the code. You can run them with:
poetry run black ..poetry run isort ..
We also use flake8 to lint the code and mypy to type check it. You can run them with:
poetry run flake8 ..poetry run mypy ..
By contributing to python-healthchecklib, you agree that your contributions will be licensed under the MIT License.