We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
First, read these guidelines.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Before you begin making changes, state your intent to do so in an Issue. Then, fork the project and create a new branch. Make changes in your copy of the repository. Then open a pull request once your changes are ready.
The project follows a convention of:
- Maximum line length: 120 characters
- Use reorder-python-imports
- Use autopep8, flake8
- Strict PEP8 conventions.
- Completely type hinted and verified using mypy
- No type comments
- Three double quotes around docstrings.
All theses can be done using pre-commit. To use pre-commit on this project run the following commands after forking the repo.
pip install -r requirements-dev.txt
pre-commit install
This will enforce all the code styling before you commit.
When a new addition is made to the source code, test should be written to prove that you changes work and does not break the existing code