How can you contribute to this project ?
You can help by finding new issues & reporting them by creating new issues.
You can help by picking an issue, or choosing to add a new test/feature (create an issue before you start coding).
-
Create a new issue, receive positive feedback.
-
Fork the repo, clone it.
-
Install pre-commit & unit tests dependencies.
python3 -m pip install pre-commit python3-venv python2 -m pip install virtualenv
-
Install pre-commit hooks.
pre-commit install
-
Create new branch.
git checkout -b mybranch
-
Add your code.
-
(Facultative) Add tests ?
-
Add yourself in AUTHORS.md.
-
Commit, push.
Make sure that pre-commit runs isort, black, flake8 &launch_checks.sh. Example. -
Create a Pull Request.
-
We're using bluejava's git-commit-guide for our commits description. Here's a quick reference:
