Merge rust-bitcoin/rust-bitcoin#2578: Document how to write commits

8bd0394b0a Document how to write commits (Tobin C. Harding)

Pull request description:

  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.

ACKs for top commit:
  apoelstra:
    ACK 8bd0394b0a

Tree-SHA512: b2713c2882c3153152091bd2a72a473e151cf1e3e93288ae17b773c9f2944805a78c991437c9951d9fe5478c76a31d5c0f2ac0212bda6cbca531681a7b41f988
This commit is contained in:
Andrew Poelstra 2024-03-22 14:04:17 +00:00
commit 08ff359dc7
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 6 additions and 0 deletions

View File

@ -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 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. 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
adhere to the ideas presented in the following two blog posts:
- [How to Write a Git Commit Message](https://cbea.ms/git-commit/)
- [Write Better Commits, Build Better Projects](https://github.blog/2022-06-30-write-better-commits-build-better-projects/)
### Peer review ### Peer review
Anyone may participate in peer review which is expressed by comments in the pull Anyone may participate in peer review which is expressed by comments in the pull