LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity

Merge #14600: docs: Clarify commit message guidelines

Browse source 
0e6de3aacb 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
This commit is contained in:
Wladimir J. van der Laan 2018-11-01 14:24:51 +01:00
commit d38a5092f1
No known key found for this signature in database
GPG key ID: 1E4AED62986CD25D
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -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 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. 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 Please refer to the [Git manual](https://git-scm.com/doc) for more information
about Git. about Git.
@ -135,6 +137,10 @@ before it will be merged. The basic squashing workflow is shown below.
# Save and quit. # Save and quit.
git push -f # (force push to GitHub) 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 If you have problems with squashing (or other workflows with `git`), you can
alternatively enable "Allow edits from maintainers" in the right GitHub alternatively enable "Allow edits from maintainers" in the right GitHub
sidebar and ask for help in the pull request. sidebar and ask for help in the pull request.