Trojstenovy web
This project uses pre-commit.
You can install it using pip install pre-commit and it's also included in the project requirements.
Activate it with
pre-commit install --allow-missing-configFor dependency management we use Poetry. See https://poetry.eustace.io/docs/#installation for installation manual.
Please follow the installation manual here: https://github.com/trojsten/web/wiki/Návod-na-inštaláciu
Please send a pull request with a descriptive title and all necessary information in the description. Preferably all in English. The pull request needs to pass automatic checks and have at least one approval from the project maintainers.
We currently check the following things:
- code style
- the code must follow black codestyle. The easiest way to achieve this is to automatically format the code with the
blacktool. This is also enforced by the pre-commit check. Note that black is currently not included in the project requirements, because it requires Python 3.6+. - imports must be sorted alphabetically (within import categories). You can use
isortto automatically sort imports the correct way. This is also enforced by the pre-commit check. - the code must also pass
flake8lint check.
- the code must follow black codestyle. The easiest way to achieve this is to automatically format the code with the
- tests
- the PR must pass all tests
- the PR should also have sufficient code coverage.
- migrations
- the PR must include all necessary migrations. Note that Django localizes migrations, so make sure your translations are up to date (
./manage.py compilemessages) before generating migrations.
- the PR must include all necessary migrations. Note that Django localizes migrations, so make sure your translations are up to date (
