Skip to content

Commit d38a509

Browse files
committed
Merge #14600: docs: Clarify commit message guidelines
0e6de3a added details about commit messages (Martin Erlandsson) Pull request description: In this small PR, the gist of [this helpful and informative comment from @fanquake](bitcoin/bitcoin#14583 (comment)) is added to the official contributing instructions, to help future first-time contributors get their commit messages right. Tree-SHA512: ca6e9b639e007944314690ef771470f346d6f0ad8aa398abf86e45258bc617334fdbd2ca10ff930d62669a5eca5b507a3ebae11f75971f80f8a44b0bb17ab054
2 parents b312579 + 0e6de3a commit d38a509

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ If a particular commit references another issue, please add the reference. For
6767
example: `refs #1234` or `fixes #4321`. Using the `fixes` or `closes` keywords
6868
will cause the corresponding issue to be closed when the pull request is merged.
6969

70+
Commit messages should never contain any `@` mentions.
71+
7072
Please refer to the [Git manual](https://git-scm.com/doc) for more information
7173
about Git.
7274

@@ -135,6 +137,10 @@ before it will be merged. The basic squashing workflow is shown below.
135137
# Save and quit.
136138
git push -f # (force push to GitHub)
137139

140+
Please update the resulting commit message if needed, it should read as a
141+
coherent message. In most cases this means that you should not just list the
142+
interim commits.
143+
138144
If you have problems with squashing (or other workflows with `git`), you can
139145
alternatively enable "Allow edits from maintainers" in the right GitHub
140146
sidebar and ask for help in the pull request.

0 commit comments

Comments
 (0)