First off, thank you for considering contributing to pydhis2. It's people like you that make pydhis2 such a great tool.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.
This is one of the simplest ways to contribute. If you find a bug, please ensure the bug was not already reported by searching on GitHub under Issues.
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.
If you have an idea for an enhancement, please open an issue to discuss it. This allows us to coordinate our efforts and prevent duplication of work.
Unsure where to begin contributing to pydhis2? You can start by looking through these good-first-issue and help-wanted issues:
- Good first issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
good-first-issueissues.
- Fork the repo 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.
- Make sure your code lints.
- Issue that pull request!
We use ruff to format our code. Please run ruff format . before committing your changes.
We also use ruff for linting. Please run ruff check . to check for any linting errors.
By contributing, you agree that your contributions will be licensed under its Apache License 2.0.