Style guideline

[VoigtSebastian]

General

• Why is this an issue? Because I want feedback and everybody can easily tell my why this guide is wrong and everything should be done differently
• Shouldn't we fork the project an work on this fork? Probably yes, but we are all somehow lazy, aren't we?

Branches

A personal branch should always start with you username. Every branch that does not have a leading username is a special branch that is used to synchronize work (main, development and feature-branches). Where main is the branch tracking the current release and development is used to collect features for release.

If you are working on a feature or fix a bug that is part of an issue, you create a branch that follows the form of username/issue/issue-id. This way it is clear that you are working on a specific issue.
If you work on something that is not part of an issue (shame on you), the naming-scheme should be username/information-about-branch. The information-about-branch should describe the work you are doing correctly and clearly.

If multiple people work on a single issue, a special branch is created that has the form issue/issue-id. This branch is used for synchronization and then merged into development.

Pull-Requests

You shall not merge into main, development or a feature-branch without a pr!
It is annoying to have new commits without information about what they do, do a pull-request and assign the correct people to it.

If you are working on an issue, reference the issue in the pull-request. Have look at the official documentation about how to do this..

Clean up after a successful merge. GitHub makes it easy to remove merged feature branches, if they are not used anymore, delete them.

Commits

If you want information about commit messages.

[LugsoIn2]

Anyone can look over the pull request and test it. The first person then comments on it and decides ok or not. If a second person then looks at it and decides everything is ok, this person can merge.