Commit da7cfe93 authored by Rémy Coutable's avatar Rémy Coutable Committed by Marcia Ramos

doc: Mention allowed prefixes in commit titles

Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent 43c80e10
...@@ -138,13 +138,14 @@ Commit messages should follow the guidelines below, for reasons explained by Chr ...@@ -138,13 +138,14 @@ Commit messages should follow the guidelines below, for reasons explained by Chr
- The merge request should 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. - The commit subject should contain at least 3 words.
CAUTION: **Caution:** **Important notes:**
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). - 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).
- Consider enabling [Squash and merge](../../user/project/merge_requests/squash_and_merge.md#squash-and-merge)
TIP: **Tip:** if your merge request includes "Applied suggestion to X files" commits, so that Danger can ignore those.
Consider enabling [Squash and merge](../../user/project/merge_requests/squash_and_merge.md#squash-and-merge) if your merge - The prefixes in the form of `[prefix]` and `prefix:` are allowed (they can be all lowercase, as long
request includes "Applied suggestion to X files" commits, so that Danger can ignore those. as the message itself is capitalized). For instance, `danger: Improve Danger behavior` and
`[API] Improve the labels endpoint` are valid commit messages.
#### Why these standards matter #### Why these standards matter
......
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