Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
We welcome you to use the GitHub issue tracker to report bugs, suggest features, or documentation improvements.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You are working against the latest source on the main branch.
- You check existing open, and recently merged pull requests to make sure someone else hasn't addressed the problem already.
- You open an issue before you begin any implementation. We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
Firstly, fork the repository.
use make dev within your local virtual environment.
For more information on getting started check out the official documentation
To send us a pull request, please follow these steps:
- Create a new branch to focus on the specific change you are contributing e.g.
improve/service_logic - Run all tests, and code baseline checks:
make pr- Git hooks will run linting and formatting while
make prrun deep checks that also run in the CI process
- Git hooks will run linting and formatting while
- Commit to your fork using clear commit messages.
- Open an issue in the repository and wait for feedback. We will to respond within a few days, please be patient.
- Once the issue is agreed to be implemented, open a PR.
GitHub provides additional document on forking a repository and creating a pull request.