Repository management

Overview

There is one special branch on GitHub repository - main. It contains newest version of the package. It shall always be functional (or at least passing all Continous Integration tests).
All other branches are development branches with intention to be merged to main (directly or indirectly).

Delivering changes

If you think that your task is completed (all acceptance criteria are met), create a pull request to the main branch. Review of your changes is automatically started.
You shall provide relevant information so please update your pull request in following manner:

• Add at least 2 reviewers.
• Add yourself and all other people that collaborated with you as assignees.
• Set UDS as project.
• Add in 'Linked issues' section all tasks that were implemented in your changes.
• Update description according to the guidelines included in the pull request template. Please follow the review process. Once, the review is completed, merge your changes using 'Squash and merge' button. Once your changes are merged, please delete your branch.
  GOOD JOB! THANK YOU! 👍

Releases

Each released version of main (published on PyPi) shall be tagged (tag must include package version).

Forbiden actions

You cannot:

• provide new changes (commit) directly to main
• merge your changes to main without review (pull request must be created)
• merge changes with failing Continous Integration tests
• merge changes if review is not finished (approved by reviewers)