Skip to content

Contributing

A.s edited this page Jul 13, 2023 · 30 revisions

After completing installation and running the basic, use make dev-easy schema, and then run manage.py createsuperuser (inside the container, of course). All your changes to the code will be automatically reloaded, for live debugging. If you encounter errors during your work, a shell is available thanks to Werkzeug.

You can also work without Docker, and running manually make set-dev.

If you needed to add new dependencies to the requirements/*.txt files, please do so by the means of the *.in files and the pip-compile-multi tool. Also, we are using pre-commit, please remember to install the tool and the hook after cloning the repo so that all the scripts (e.g. Black code formatter) are run before any code is added to an actual commit.

Run make env-setup-dev to install both pre-commit and pip-compile-multi under a python virtual environment in the root of the repo that's already added to the git ignore. For this rule to work, in some distros you'll need python3-venv package (of course, package name varies from distro to distro).

Clone this wiki locally