docs: Clarify commit message guidelines #14600

pull merland wants to merge 1 commits into bitcoin:master from merland:update-contrib changing 1 files +6 −0

merland commented at 12:08 PM on October 29, 2018: contributor

In this small PR, the gist of this helpful and informative comment from [@fanquake](/bitcoin-bitcoin/contributor/fanquake/) is added to the official contributing instructions, to help future first-time contributors get their commit messages right.
fanquake added the label Docs on Oct 29, 2018
practicalswift commented at 12:12 PM on October 29, 2018: contributor

ACK 73f358401cd452577a516ca565ff8f6742245808
ch4ot1c commented at 2:05 PM on October 29, 2018: contributor

Helpful, thank you!
jnewbery commented at 2:28 PM on October 29, 2018: member

"any @ mentions should be removed" isn't specific to the squashing commits section. There shouldn't be @ mentions in any commit messages at all.
merland commented at 2:40 PM on October 29, 2018: contributor

@jnewbery Thanks. Do you know if this is mentioned anywhere in the bitcoin repo?
jnewbery commented at 2:53 PM on October 29, 2018: member

I don't know. It should be in CONTRIBUTING.md if it's anywhere.
merland force-pushed on Oct 29, 2018
merland commented at 3:18 PM on October 29, 2018: contributor

@jnewbery I updated the commit after your suggestion, please have another look.
in CONTRIBUTING.md:141 in 9cb56f3b00 outdated
```
 136 | @@ -135,6 +137,9 @@ before it will be merged. The basic squashing workflow is shown below.
 137 |      # Save and quit.
 138 |      git push -f # (force push to GitHub)
 139 |  
 140 | +The commit message should be updated so that it doesn't include all the
 141 | +messages from the interim commits.
```
hebasto commented at 4:21 PM on October 29, 2018:

IMO, this requirement is not suitable for all cases.

merland commented at 8:26 PM on October 29, 2018:

Interesting! Would you (or someone else) care to elaborate? Personally I don't really know, but it seems like something that would benefit from a set guideline.

hebasto commented at 8:39 PM on October 29, 2018:

e.g., 869193f5a6398bb9e4a6f4a7aeb8d2203193c80f That commit was squashed from two ones. And its message does include all the messages from the squashed commits.

merland commented at 9:31 PM on October 29, 2018:

I think I see what you are saying; there can be cases where just listing the interim commits happens to form a coherent message.

New suggestion: Please update the resulting commit message if needed, it should read as a coherent message. In most cases this means that you should not just list the interim commits.

hebasto commented at 9:51 PM on October 29, 2018:

LGTM
merland renamed this:
~~docs: Add instructions about commit message when squashing~~
docs: Clarify commit message guidelines
on Oct 29, 2018
added details about commit messages 0e6de3aacb
merland force-pushed on Oct 30, 2018
merland commented at 7:03 AM on October 30, 2018: contributor

Commit updated after comments
fanquake deleted a comment on Oct 30, 2018
practicalswift commented at 8:15 AM on October 30, 2018: contributor

ACK 0e6de3aacb8ebbf2617e8c11b8dae61acdd79816
hebasto commented at 9:31 AM on October 30, 2018: member

ACK 0e6de3aacb8ebbf2617e8c11b8dae61acdd79816
fanquake commented at 10:47 AM on October 30, 2018: member

utACK 0e6de3a
laanwj commented at 1:24 PM on November 1, 2018: member

utACK 0e6de3aacb8ebbf2617e8c11b8dae61acdd79816
laanwj merged this on Nov 1, 2018
laanwj closed this on Nov 1, 2018
laanwj referenced this in commit d38a5092f1 on Nov 1, 2018
merland deleted the branch on Nov 22, 2018
PastaPastaPasta referenced this in commit 478f840f4a on Jun 27, 2021
PastaPastaPasta referenced this in commit 430dc17ab0 on Jun 28, 2021
PastaPastaPasta referenced this in commit 84f99fcd17 on Jun 29, 2021
PastaPastaPasta referenced this in commit c96e59bed9 on Jul 1, 2021
PastaPastaPasta referenced this in commit d2ed900d7d on Jul 1, 2021
PastaPastaPasta referenced this in commit 411abc541d on Jul 1, 2021
PastaPastaPasta referenced this in commit 0ed7a8622a on Jul 3, 2021
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#14583 docs: Textual improvements in build docs