From b5b72fffc0e2cd3623f56f6cb0cccaade8a553b7 Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Tue, 21 May 2024 23:43:16 +0100 Subject: [PATCH] Add daily email for 2024-05-19 Better commit messages means better pull requests --- source/_daily_emails/2024-05-19.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 source/_daily_emails/2024-05-19.md diff --git a/source/_daily_emails/2024-05-19.md b/source/_daily_emails/2024-05-19.md new file mode 100644 index 00000000..d7d93004 --- /dev/null +++ b/source/_daily_emails/2024-05-19.md @@ -0,0 +1,27 @@ +--- +title: Better commit messages means better pull requests +date: 2024-05-19 +permalink: daily/2024/05/19/better-commit-messages-better-pull-requests +tags: + - software-development + - git +cta: ~ +snippet: | + If you write better commit messages, you'll get better pull requests. +--- + +If you're working on a team or project that uses pull or merge requests, then [writing commit messages with detailed descriptions][0] using the message body and not just the subject line, will result in better pull requests. + +Whatever text you put in the message body will be used as the description for your pull or merge request, as well as the subject line being used for the title. + +So, instead of writing the message after completing the work, when you may forget important details, write it at the time in the message when writing the commit and re-use it in the PR or MR. + +Pull or merge requests with more information and detail are more likely to be accepted and merged. + +The text will also remain in the pull or merge request, even if [someone squashes your commits and deletes the old messages][1]. + +The issue then is, [what if you move to a different Git hosting service][2]? + +[0]: {{site.url}}/daily/2024/05/17/why-i-dont-commit-with--m +[1]: {{site.url}}/daily/2024/05/11/don-t-delete-my-commit-messages +[2]: {{site.url}}/daily/2024/05/15/should-you-include-issue-ids-in-your-commit-messages