CONTRIBUTING.md

Contributing

Contributions to mySAGW are very welcome! Best have a look at the open issues and open a GitHub pull request. See instructions below how to set up development environment. Before writing any code, best discuss your proposed change in a GitHub issue to see if the proposed change makes sense for the project.

Setup development environment

Clone

To work on mysagw you first need to clone

git clone https://github.com/adfinis/mySAGW.git
cd mySAGW

Build the dev containers

By default, it pulls images for prod, that don't contain any tooling needed during dev. In order to have those tools available, you need to build those containers first:

docker compose build --pull api caluma

Open Shell

Once it is cloned you can easily open a shell in the docker container to open a development environment.

# needed for permission handling
# only needs to be run once
echo UID=$UID > .env
# open shell
docker compose run --rm mysagw bash

Testing

Once you have shelled in docker container as described above you can use common python tooling for formatting, linting, testing etc.

# linting
ruff check .
# format code
ruff format .
# running tests
pytest
# create migrations
./manage.py makemigrations
# you can use pip to install other temporary dependencies

Writing of code can still happen outside the docker container of course.

Install new requirements

In case you're adding new requirements you simply need to build the docker container again for those to be installed and re-open shell.

docker compose build --pull

Setup pre commit

Pre commit hooks is an additional option instead of executing checks in your editor of choice.

First create a virtualenv with the tool of your choice before running below commands:

pip install pre-commit
pip install -r requiements-dev.txt -U
pre-commit install