Commit 117aa796 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch '267599-improve-commit-message-guidelines-doc' into 'master'

Improve a bit the commit message guidelines

See merge request gitlab-org/gitlab!46372
parents 26e3545d 43a31913
...@@ -123,24 +123,36 @@ document from the Kubernetes team also has some great points regarding this. ...@@ -123,24 +123,36 @@ document from the Kubernetes team also has some great points regarding this.
### Commit messages guidelines ### Commit messages guidelines
When writing commit messages, please follow the guidelines below: Commit messages should follow the guidelines below, for reasons explained by Chris Beams in [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/):
- The commit subject must contain at least 3 words. - The commit subject and body must be separated by a blank line.
- The commit subject must not be longer than 72 characters.
- The commit subject must start with a capital letter. - The commit subject must start with a capital letter.
- The commit subject must not be longer than 72 characters.
- The commit subject must not end with a period. - The commit subject must not end with a period.
- The commit subject and body must be separated by a blank line.
- The commit body must not contain more than 72 characters per line. - The commit body must not contain more than 72 characters per line.
- Commits that change 30 or more lines across at least 3 files must - Commits that change 30 or more lines across at least 3 files must
describe these changes in the commit body. describe these changes in the commit body.
- The commit subject or body must not contain Emojis. - The commit subject or body must not contain Emojis.
- Use issues and merge requests' full URLs instead of short references, - Use issues and merge requests' full URLs instead of short references,
as they are displayed as plain text outside of GitLab. as they are displayed as plain text outside of GitLab.
- The merge request must not contain more than 10 commit messages. - The merge request should not contain more than 10 commit messages.
- The commit subject should contain at least 3 words.
If the guidelines are not met, the MR will not pass the CAUTION: **Caution:**
If the guidelines are not met, the MR may not pass the
[Danger checks](https://gitlab.com/gitlab-org/gitlab/blob/master/danger/commit_messages/Dangerfile). [Danger checks](https://gitlab.com/gitlab-org/gitlab/blob/master/danger/commit_messages/Dangerfile).
For more information see [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
TIP: **Tip:**
Consider enabling [Squash and merge](../../user/project/merge_requests/squash_and_merge.md#squash-and-merge) if your merge
request includes "Applied suggestion to X files" commits, so that Danger can ignore those.
#### Why these standards matter
1. Consistent commit messages that follow these guidelines make the history more readable.
1. Concise standard commit messages helps to identify breaking changes for a deployment or ~"master:broken" quicker when
reviewing commits between two points in time.
#### Commit message template
Example commit message template that can be used on your machine that embodies the above (guide for [how to apply template](https://codeinthehole.com/tips/a-useful-template-for-commit-messages/)): Example commit message template that can be used on your machine that embodies the above (guide for [how to apply template](https://codeinthehole.com/tips/a-useful-template-for-commit-messages/)):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment