From 8bd0394b0a4ebadf6ae6f57fca1e052c2eb5ec50 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Wed, 13 Mar 2024 09:51:35 +1100 Subject: [PATCH] Document how to write commits 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. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 124bb284..e1e365f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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