oliverdavies.uk/content/node.74447b1a-33da-45b7-aa4b-a35e2afb6803.yml

68 lines
3.3 KiB
YAML

uuid:
- value: 74447b1a-33da-45b7-aa4b-a35e2afb6803
langcode:
- value: en
type:
- target_id: daily_email
target_type: node_type
target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
revision_timestamp:
- value: '2025-05-11T09:00:12+00:00'
revision_uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
revision_log: { }
status:
- value: true
uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
title:
- value: 'Better commit messages means better pull requests'
created:
- value: '2024-05-19T00:00:00+00:00'
changed:
- value: '2025-05-11T09:00:12+00:00'
promote:
- value: false
sticky:
- value: false
default_langcode:
- value: true
revision_translation_affected:
- value: true
path:
- alias: /daily/2024/05/19/better-commit-messages-better-pull-requests
langcode: en
body:
- value: |
<p>If you're working on a team or project that uses pull or merge requests, then <a href="/daily/2024/05/17/why-i-dont-commit-with--m">writing commit messages with detailed descriptions</a> using the message body and not just the subject line, will result in better pull requests.</p>
<p>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.</p>
<p>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.</p>
<p>Pull or merge requests with more information and detail are more likely to be accepted and merged.</p>
<p>The text will also remain in the pull or merge request, even if <a href="/daily/2024/05/11/don-t-delete-my-commit-messages">someone squashes your commits and deletes the old messages</a>.</p>
<p>The issue then is, <a href="/daily/2024/05/15/should-you-include-issue-ids-in-your-commit-messages">what if you move to a different Git hosting service</a>?</p>
format: full_html
processed: |
<p>If you're working on a team or project that uses pull or merge requests, then <a href="http://default/daily/2024/05/17/why-i-dont-commit-with--m">writing commit messages with detailed descriptions</a> using the message body and not just the subject line, will result in better pull requests.</p>
<p>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.</p>
<p>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.</p>
<p>Pull or merge requests with more information and detail are more likely to be accepted and merged.</p>
<p>The text will also remain in the pull or merge request, even if <a href="http://default/daily/2024/05/11/don-t-delete-my-commit-messages">someone squashes your commits and deletes the old messages</a>.</p>
<p>The issue then is, <a href="http://default/daily/2024/05/15/should-you-include-issue-ids-in-your-commit-messages">what if you move to a different Git hosting service</a>?</p>
summary: null
field_daily_email_cta: { }