From ed45c8e692b2985a431d8ea78612b0f9ba803033 Mon Sep 17 00:00:00 2001 From: Nick Charlton Date: Fri, 28 Mar 2025 13:22:11 +0000 Subject: [PATCH] Write commit messages for humans You should tell a story for your fellow programmers, not fit within arbitary rules followed in other places. However, if the repository is already following such a rule, you should do so for consistency. --- git/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/git/README.md b/git/README.md index e0654667..d4df79c5 100644 --- a/git/README.md +++ b/git/README.md @@ -7,6 +7,8 @@ A guide for programming within version control. - Avoid merge commits by using a [rebase workflow]. - Squash multiple trivial commits into a single commit. - Write a [good commit message]. +- Write commit messages for humans, not machines (i.e.: avoid "chore:" and + other Git patterns). [rebase workflow]: https://github.com/thoughtbot/guides/blob/main/git/README.md#merge [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html