opdavies/oliverdavies.uk
1
0
Fork 0
Code Issues 1 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Change old /archive/* links to /daily/*

Browse source
This commit is contained in:
Oliver Davies 2024-12-19 20:26:33 +00:00
parent 661669f2a5
commit 538141466c
406 changed files with 457 additions and 457 deletions
Download patch file Download diff file Expand all files Collapse all files

6
source/_daily_emails/2023-01-24.md
View file

@ -3,12 +3,12 @@ title: >
Small commits and good commit messges
pubDate: 2023-01-24
permalink: >-
archive/2023/01/24/small-commits-and-good-commit-messges
daily/2023/01/24/small-commits-and-good-commit-messges
tags:
- git
---
An important thing when using a tool like [git bisect]({{site.url}}/archive/2023/01/23/debugging-with-git-bisect) as well as reviewing pull/merge requests and commits is to have small (aka "atomic") commits.
An important thing when using a tool like [git bisect]({{site.url}}/daily/2023/01/23/debugging-with-git-bisect) as well as reviewing pull/merge requests and commits is to have small (aka "atomic") commits.
Commits with small changes make them easier to review and, if needed, to revert and debug with bisect. If a commit has ten new or changed lines, it's much easier to see and fix a bug than if the commit had a hundred lines.
@ -20,4 +20,4 @@ Also take some time to write good, informative commit messages.
As well as the short one-line subject, you can add as much detail as you need to the body of the message about the change that's being committed, why it's needed, what other approaches were considered or tried, as well as links to supporting documentation such as ADRs, technical design documents or diagrams.
Having as much information as possible makes it much easier when someone needs to review or fix a specific commit. I like to use the [conventional commits specification]({{site.url}}/archive/2022/09/01/conventional-commits-changelogs), though the main objective is to have all of the information documented so it's available in the future.
Having as much information as possible makes it much easier when someone needs to review or fix a specific commit. I like to use the [conventional commits specification]({{site.url}}/daily/2022/09/01/conventional-commits-changelogs), though the main objective is to have all of the information documented so it's available in the future.