Instructions for Developers

This sections contains information for developers who either want to report a bug or create a pull request. Please adhere to the guidelines below:

• Report an issue
• Creating a pull request

How-to open an issue

If you wish to raise an issue to either report a bug or a suggestion to a new feature for the server feel free to do so. When raising an issue please add tags with appropriate labels to the problem. This makes maintenance easier for the people responsible for the server, since the issues can be assigned easily. The labels already created that will be the most applicable to use for outside users:

• bug (bug)
• database (issue related to database)
• documentation (unclear or missing documentation)
• enhancement (new features)
• invalid
• needs discussion (methodological concerns)
• question
• server (server/endpoint specific problems)
• tenant (server-tenant interaction problems e.g. reference tenant) Note often more labels are applicable to a single issue.

How-to contribute to the repository

This repository utilizes a branch "development" for all current developments of the server. When making a new pull request it is therefore important to branch out from the "development" branch. When a new release of FINALES is ready and the code in the "development" branch is stable, a new release from the "development" branch to the "main" branch will be scheduled.

To contribute notice the pre-commits necessary for this repository (black, flake8, etc.), which will a necessity for successful CI in all PRs. The pre-commit package is installed as part of the FINALES requirements. Run

(base) root@container$ pre-commit install

Onec a PR is done and ready for review please assign MonikaVo (Monika Vogler) or SKS94 (Simon Krarup Steensen), who manages the repository.