From 182d8fb124607abec0853be2f6365d7b5106333f Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Wed, 4 Sep 2024 23:47:48 +0100 Subject: [PATCH] Add daily email for 2024-09-03 Do your commit messages still make sense? --- source/_daily_emails/2024-09-03.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 source/_daily_emails/2024-09-03.md diff --git a/source/_daily_emails/2024-09-03.md b/source/_daily_emails/2024-09-03.md new file mode 100644 index 00000000..e313e2df --- /dev/null +++ b/source/_daily_emails/2024-09-03.md @@ -0,0 +1,30 @@ +--- +title: Do your commit messages still make sense? +date: 2024-09-03 +permalink: daily/2024/09/03/do-your-commit-messages-still-make-sense +tags: + - software-development + - git +cta: d7eol +snippet: | + Do your commit messages still make sense? +--- + +Once you've [cleaned up and tided your commits][1], re-ordered them and squashed any commits together to combine them into logical changes, before you push them, you should also check if your commit messages still make sense. + +Using short or generic commit messages is fine when spiking a solution in very short feedback loops, but when you push your changes, you want them to be as descriptive and meaningful as possible. + +If someone ran `git log` weeks, months or years from now, would they get value from reading the commit messages? + +Are you using the subject and body correctly and wrapping text when needed? + +Does each message accurately reflect and describe the change? + +Does it capture why the change is needed, any alternative approaches that we considered or tried, or any complications that were encountered? + +If you're following a standard like [conventional commits][0], have you correctly included the required information, such as the type, scope and any references, such as the task reference? + +Having a Git log with detailed history is valuable when you need to review the changes in the future, but it also makes it more likely your changes will be approved and merged, whether you're working on a paid project or volunteering on an open-source project. + +[0]: {{site.url}}/archive/2022/09/01/conventional-commits-changelogs +[1]: {{site.url}}/daily/2024/09/02/no-one-sees-your-clean-up-commits