Skip to content

Commit

Permalink
Document how to write commits
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tcharding committed Mar 12, 2024
1 parent 6f6cc00 commit 370a294
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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

Anyone may participate in peer review which is expressed by comments in the pull
Expand Down

0 comments on commit 370a294

Please sign in to comment.