Contributing

Contributions are welcome. Please note the Code of Conduct and set up pre-commit as described below.

Tool & Repository setup

You will need the following tools:

go. For the specific version used, check the pre-commit workflow at the go-version configuration
pre-commit
docker

Once those are installed, run make setup to perform the repository setup.

Development commands

make devserver will start a development server on port 8080 and and rebuild the project every time the code changes.
make frontend extracts the frontend files and puts them into the ./public directory so they work with make devserver
make test runs all tests
make coverage runs all tests and opens the coverage report in your browser
make build builds the software with production configuration

Commit messages

This project uses Conventional commits to enable better overview over changes and enables automated tooling based on commit messages.