Skip to content

Commit bdf88c1

Browse files
committed
CONTRIBUTING: explain no-merge keywords
1 parent d39d7ed commit bdf88c1

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,10 @@ It is possible to check if your code follows these conventions:
149149
simple as it is.
150150
```
151151

152+
* The commit message is automatically checked by the static tests for keywords
153+
that prevent a merge, for example "fixup" or "DONOTMERGE". The full list
154+
of these keywords is stored in `dist/tools/pr_check/no_merge_keywords`.
155+
152156
### Pull Requests
153157
[pull requests]: #pull-requests
154158

@@ -304,6 +308,9 @@ $ git commit --fixup <prefix2 commit hash>
304308

305309
### Squash commits after review
306310

311+
*** Note: If the static tests warn you about a no-merge keyword, please look
312+
at [our commit conventions][commit-conventions].
313+
307314
Squashing a commit is done using the rebase subcommand of git in interactive
308315
mode:
309316

@@ -323,7 +330,7 @@ phase, squashing commits can be performed in a single command:
323330
$ git rebase -i --autosquash
324331
```
325332

326-
**Watch out: Don't squash your commit until a maintainer asks you to do it.**
333+
***Watch out: Don't squash your commit until a maintainer asks you to do it.***
327334

328335
Otherwise the history of review changes is lost and for large PRs, it
329336
makes it difficult for the reviewer to follow them. It might also happen that

0 commit comments

Comments
 (0)