diff options
| author | Wladimir J. van der Laan <laanwj@gmail.com> | 2018-11-01 14:24:51 +0100 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2018-11-01 14:24:56 +0100 |
| commit | d38a5092f17ff4c357c5cfd4e6caee33cbafcbf0 (patch) | |
| tree | bd97217722b877c9cd8c9da4f14f3f9fbc8ceb1d | |
| parent | b312579c69f10f23f62934b8f860cef89c2ffe87 (diff) | |
| parent | 0e6de3aacb8ebbf2617e8c11b8dae61acdd79816 (diff) | |
Merge #14600: docs: Clarify commit message guidelines
0e6de3aacb8ebbf2617e8c11b8dae61acdd79816 added details about commit messages (Martin Erlandsson)
Pull request description:
In this small PR, the gist of [this helpful and informative comment from @fanquake](https://github.com/bitcoin/bitcoin/pull/14583#issuecomment-433668211) is added to the official contributing instructions, to help future first-time contributors get their commit messages right.
Tree-SHA512: ca6e9b639e007944314690ef771470f346d6f0ad8aa398abf86e45258bc617334fdbd2ca10ff930d62669a5eca5b507a3ebae11f75971f80f8a44b0bb17ab054
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d5dc3221b..08b2fa609e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,6 +67,8 @@ If a particular commit references another issue, please add the reference. For example: `refs #1234` or `fixes #4321`. Using the `fixes` or `closes` keywords will cause the corresponding issue to be closed when the pull request is merged. +Commit messages should never contain any `@` mentions. + Please refer to the [Git manual](https://git-scm.com/doc) for more information about Git. @@ -135,6 +137,10 @@ before it will be merged. The basic squashing workflow is shown below. # Save and quit. git push -f # (force push to GitHub) +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. + If you have problems with squashing (or other workflows with `git`), you can alternatively enable "Allow edits from maintainers" in the right GitHub sidebar and ask for help in the pull request. |