Document how to write commits #2578
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Review the rendered version of these changes here: https://github.com/tcharding/rust-bitcoin/blob/03-13-commit-tips/CONTRIBUTING.md#preparing-prs |
Pull Request Test Coverage Report for Build 8274539858Details
💛 - Coveralls |
apoelstra
reviewed
Mar 13, 2024
CONTRIBUTING.md
Outdated
| @@ -118,6 +118,12 @@ NB: reviewers may run more complex test/CI scripts, thus, satisfying all the | |||
| requirements above is just a preliminary, but not necessary sufficient step for | |||
| getting the PR accepted as a valid candidate PR for the `master` branch. | |||
|
|
|||
| High quality commits help us review and merge you contributions, we attempt to | |||
There was a problem hiding this comment.
In 370a294:
This , should be a period, and capital We.
|
BTW. Instead of/along with writing it in a document, you might want to set up a git commit template and some simple hook to install it. Example from Fedimint:
as you see it's slightly different, but we could put anything there really. A link for new contributors, or to a bigger guide, or even a wallet of text verbatim. |
Reviewers often find themselves linking to blog posts to encourage newer devs to improve their commit logs, we can save everyones time by putting the links in the contributing docs, then we can just point devs there.
tcharding
force-pushed
the
03-13-commit-tips
branch
from
370a294
to
8bd0394
Compare
|
Fixed grammar as suggested. |
apoelstra
approved these changes
Mar 14, 2024
|
This is docs only, could go in with a single ack. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reviewers often find themselves linking to blog posts to encourage newer devs to improve their commit logs, we can save everyones time by putting the links in the contributing docs, then we can just point devs there.