This is a how-to-contribute guide for the template itself. This guide is not about contributing to the project that is created using this template.
We use poetry
to manage the dependencies.
If you dont have poetry
installed, you should run the command below.
make download-poetry
To install dependencies and prepare pre-commit
hooks you would need to run install
command:
make install
To activate your virtualenv
run poetry shell
.
After you run make install
you can execute the automatic code formatting.
make codestyle
Many checks are configured for this project. Command make check-style
will run black diffs, darglint docstring style and mypy.
The make check-safety
command will look at the security of your code.
You can also use STRICT=1
flag to make the check be strict.
Before submitting your code please do the following steps:
- Add any changes you want
- Add tests for the new changes
- Edit documentation if you have changed something significant
- Update
CHANGELOG.md
with a quick summary of your changes - Run
make codestyle
to format your changes. - Run
STRICT=1 make check-style
to ensure that types and docs are correct - Run
STRICT=1 make check-safety
to ensure that security of your code is correct
You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.