oliverdavies.uk/content/node.73861efd-5d4e-4c80-8c22-57594ee43dbc.yml

uuid:
  - value: 73861efd-5d4e-4c80-8c22-57594ee43dbc
langcode:
  - value: en
type:
  - target_id: daily_email
    target_type: node_type
    target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
revision_timestamp:
  - value: '2025-08-03T22:53:21+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: "A CHANGLOG isn't just a list of Git commits"
created:
  - value: '2025-07-28T21:53:38+00:00'
changed:
  - value: '2025-08-03T22:53:21+00:00'
promote:
  - value: false
sticky:
  - value: false
default_langcode:
  - value: true
revision_translation_affected:
  - value: true
path:
  - alias: /daily/2025/08/28/changlog-isnt-just-list-git-commits
    langcode: en
body:
  - value: |-
      Yesterday, I wrote about [keeping a CHANGELOG][0] for software projects, and about the <https://keepachangelog.com> project.

      I like this slogan on their website:

      > Don’t let your friends dump git logs into changelogs.

      A CHANGELOG shouldn't be a list of Git commits in a file.

      It should be in a human-readable format that's easy for people to read and understand, whether they are technical or not.

      This probably isn't the case for the output from `git log`, which may also contain commits like `Refactor` and `wip` that don't mean anything to someone who focused on the higher-level deliverables.

      Git logs are great for Developers, but CHANGELOGs are for everyone.

      [0]: /daily/2025/07/27/do-you-keep-changelog
    format: markdown
    processed: |
      <p>Yesterday, I wrote about <a href="http://localhost:8888/daily/2025/07/27/do-you-keep-changelog">keeping a CHANGELOG</a> for software projects, and about the <a href="https://keepachangelog.com">https://keepachangelog.com</a> project.</p>
      <p>I like this slogan on their website:</p>
      <blockquote><p>Don’t let your friends dump git logs into changelogs.</p>
      </blockquote>
      <p>A CHANGELOG shouldn't be a list of Git commits in a file.</p>
      <p>It should be in a human-readable format that's easy for people to read and understand, whether they are technical or not.</p>
      <p>This probably isn't the case for the output from <code>git log</code>, which may also contain commits like <code>Refactor</code> and <code>wip</code> that don't mean anything to someone who focused on the higher-level deliverables.</p>
      <p>Git logs are great for Developers, but CHANGELOGs are for everyone.</p>
    summary: ''
field_daily_email_cta:
  - target_type: node
    target_uuid: 9b4c39a3-702f-486c-a79b-4d7b96a4f3f6