Commit messages
Avoid duplications and redundancies
When you commit to the
testbed
repository it is not necessary to use a prefixtestbed:
(e.g.Remove all easter eggs
instead oftestbed: remove all easter eggs
When you commit to the
testbed
repository, it is not necessary to say that you are committing to the testbed repository (e.g.Remove all easter eggs
instead ofRemove all easter eggs in the testbed repository
)
Squash merge
When using squash merge, the commit message must always be revised manually.
The following commit message from a squash merge of a PR with 3 commits makes no sense.
Reposistory for meeting minutes
* Reposistory for meeting mintues
Signed-off-by: Mathias Fechner <fechner@osism.tech>
* insert new line at the end
Signed-off-by: Mathias Fechner <fechner@osism.tech>
* yaml-linting
Signed-off-by: Mathias Fechner <fechner@osism.tech>
This commit message should look like the following after the squash merge. Commits that were added in a PR just to make the CI happy do not need to be mentioned in the final commit message.
Multiple lines with a signed-off-by from the same author don’t make sense either.
Reposistory for meeting minutes
Signed-off-by: Mathias Fechner <fechner@osism.tech>
References to issues
We work with the issues from GitHub. The issues can be referenced in commit messages. See https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.
To close an issue via a commit, Closes #NUMBER_OF_THE_ISSUE
is used as the last
line above the Signed-off-by
line. If issue is referenced in another repository
Closes osism/NAME_OF_THE_REPOSITORY#NUMBER_OF_THE_ISSUE
accordingly .
If a commit belongs to an issue, but does not close it directly, Related to #NUMBER_OF_THE_ISSUE
or Part of #NUMBER_OF_THE_ISSUE
is used.
The reference to an issue is never placed directly in the title of the commit message.