Top
Best
New

Posted by yedhukrishnan 4 hours ago

Commit description as a thinking tool(yedhu.me)
102 points | 58 comments
WD-42 3 hours ago|
Writing is thinking in every situation, not just limited to commit messages. This is a fact that I'm concerned people are forgetting, or worse never understood to begin with.
bunderbunder 1 hour ago||
I returned to doing a lot of my own coding for this reason.

I don't mind farming out the more monotonous bits to AI. When I was letting an agent handle the whole implementation for me, though, I found that I was rediscovering all the pitfalls of waterfall-style development. Because I was doing waterfall-style development. I was trying to pin down all the details in a plan document up front, which is inevitably the point in time where I know the absolute least about the best way to accomplish the task. And then I let the agent do the rest for me, which undermines my opportunity to learn and understand more.

The result was continual accumulation of bad decisions and unnecessary technical debt. The only difference between now and back in the bad old days of 20 years ago is this time instead of being the put-upon code monkey I had become the boneheaded engineering manager who isn't paying attention to the code and doesn't realize what a brittle mess it's become.

fasterik 2 hours ago|||
This. I've recently (re-)discovered the importance of using writing to force myself to confront my assumptions and gaps in knowledge. It's easy to fool yourself into thinking that you understand something if you haven't made it concrete and explicit by exercising your own brain. Arguably, this extends beyond writing in the conventional sense to many cognitive domains: mathematics, programming, physics, engineering, etc. AI should help the process of thinking, not replace it.
msdz 1 hour ago||
Your point rings home hard to me at the moment, as I’ve recently been trying to write up several small-ish topics in blog form, so as to have a link ready to share when an oft-discussed topic inevitably comes up again online, and some of those arguments, while I had read up on them in the past, include things I’m not entirely familiar with.

And I’ll just say, after this exercise I can definitely concur that writing exposes gaps in your thinking very fast. Especially when you’re trying to explain your point to someone who is new to the topic.

ModernMech 2 hours ago||
Did you think about this comment or are you just repeating something you heard and that’s been said in every discussion on HN about writing and AI?
WD-42 2 hours ago|||
I read the linked article, thought the idea was generalizable, and posted that thought. Something wrong with that?
ModernMech 1 hour ago||
"Writing is thinking" is being repeated all the time lately to the point it seems like a meme.
WD-42 1 hour ago||
Does that make it untrue?
ModernMech 1 hour ago||
I would say probably most memeing is not really thought provoking or inducing. I agree most of the time writing can help collect one's thoughts but it can also be completely thoughtless. Probably what matters more is the specific process.
1718627440 1 hour ago|||
Recalling, recategorizing and expressing is still thinking?
evnp 2 hours ago||
> When the AI doesn’t know the ‘why’ part, it comes up with its own reasoning. I find that dangerous. When we read that later, it may not make sense, because the real reason was completely different.

Even more dangerous: when the text _does_ make sense, despite being detached from reality.

fphilipe 47 minutes ago|
I have this rule in my global AGENTS.md:

> When writing a commit message, briefly explain at a high level what was done (the details are in the code). Explain the why of the commit; if you don't know that, ask me.

It works quite well. When it doesn't have it in context, it does ask.

arialdomartini 3 hours ago||
On top of this, it pays off to write the commit messages before the code

https://arialdomartini.github.io/pre-emptive-commit-comments

drdaeman 3 hours ago||
Jujutsu is perfect for that - you create new changeset upfront, providing message at the same time (which can be later amended as needed). Feels so much more logical to declare the topic first, rather than come back to some accidentally uncommitted changes and wonder what was doing there.
arialdomartini 2 hours ago|||
Exactly! For anyone interested, I guess the previous comment refers to the Squash Workflow, which happens to be very idiomatic in Jujutsu

https://arialdo.codeberg.page/ju-ju-tsu/tutorial/moving/squa...

xixixao 2 hours ago||||
"Topic" is usually covered by branch name. Commit message goes with a set of code changes, it feels more logical to me for the message to describe the actual code as it was written (as it might have changed from the idea phase).
sbuttgereit 2 hours ago||
In Git, but workflows in Jujutsu aren't necessarily the same as in Git.

Branches for example aren't named in Jujutsu. You can bookmark them which gives them a name in some sense... but that's an optional thing you can do, often as a concession to centralized Git interoperability.

So in this case the parent to your post isn't thinking about it wrong given the context and such workflows have their advantages I've found.

SAI_Peregrinus 1 hour ago||
Also branch names are extremely limited in what they can describe.
1718627440 1 hour ago||||
You can start to write the commit message first in Git too. (And I do that.)
TeMPOraL 2 hours ago|||
Agreed. You can preplan a bunch of small steps and then fill in changes.
tommica 2 hours ago|||
On hindsight that should be obvious! Pre-write your commit message, because of course you know what you are going to work on!
Sarkie 2 hours ago||
BDD. Absolutely changed my world
Garlef 2 hours ago||
As in gherkin/cucumber? Or more generally?

(the language... I, for the love of it, can't remember which is which)

kccqzy 3 hours ago||
Long ago I changed the default commit message to include headers “Why?” and “How?” to remind myself that I need to explain why a change is made (what this article focuses on), and how it is made (different implementation approaches considered). I followed this format for a long time. I was in the top 1% for commit message length at the company.

Tangent: I once worried about things breaking when commit messages got too long. I tried really long commit messages and nothing broke: https://github.com/kccqzy/long-commit-messages/commit/ccfda4...

lokar 48 minutes ago||
Why make this change at all? Why do it this way? What would have been the next best way, and why not that? What important assumptions justify this? What's next for this? etc
cerved 2 hours ago|||
I like the Git rule of thumb. If it's too long -- it's probably not a single commit.
sublinear 3 hours ago||
To stay concise, I think bullet trees are the best. I've never had to make exceptions to this format.

Top level groups high-level concerns (optional). Below that (required) are short distillations of those concerns answering "why". Below that are descriptions of "what" was/wasn't done. A final optional level digs into deeper implementation detail.

The vast majority of my bullet trees are just those two required levels. Each commit message is rarely more than 10 or 15 lines long, and people really appreciate them. I appreciate them too since I'm the most likely to read them.

tommica 2 hours ago||
Got an example of what you mean?
dkarl 1 hour ago||
I was forced to give up on commit messages long before AI, because other people were so bad at them that I happily agreed that all PRs should squash commits.

At least then the squashed messages were usually pretty decent. But then people started using AI (or AI started using people) to create absolutely massive commit messages that are impossible to skim in git blame and overall very bad for human consumption.

AI has made massive strides in virtually every other way. Why do they continue to write in a wasteful, human-hostile way?

I think we'd have to be be very naive not to suspect that this is intentional. AI companies have a stated goal of replacing humans in the software development process, and they're actively making the process itself inhospitable for humans.

They are injecting massive amounts of text into their customers' development process, which then becomes tokens that their customers will then pay them to process over and over again. It's like a CO2 scrubber that emits CO2.

jamietanna 1 hour ago||
I'm resisting linking to several posts I've written on these lines before - I very much agree that - at least personally - writing the commit message helps me work through what's changed and most importantly why.

When AI writes the code for me, I then end up still writing the commit message so I can take ownership of the change myself, make sure I can explain why the change was made and see if there's any missing context that may lead to a different result

I did find that distilling some of my style choices to a `commit-style` skill helps when an AI writes a commit message (for me to rewrite) to be not quite as generic, but it's still needing my ownership to get it right

pnt12 36 minutes ago||
I agree with the article, but I like to write, while lots of people just see it as a chore.

To people who don't like to write a ticket or PR description, the AI text is better than nothing.

flopsamjetsam 1 hour ago||
I sometimes use the AI prompt to do a similar thing: I'm struggling with a problem, or putting my ideas down in a coherent manner, so I write a prompt, and in doing so the idea crystallises for me. I've tried doing this just in a text editor, but there's something about having the next action be "submit this to X" that clicks my brain into higher gear.

I suppose it's very similar to drafting a letter or an email to someone.

zahrevsky 3 hours ago||
I sometimes struggle to decide whether to put an explanation in a commit message, in the docs (say in an ADR). I tend to save everything as docs because files are a more “universal” interface, so to speak. They’re in plain sight and harder to miss.

I guess the main advantages of Git history are that it’s (1) uneditable and (2) directly linked to a specific commit.

mopsi 37 minutes ago|
There's an additional aspect: whoever ends up reading the messages later might not even be aware that there is more information somewhere else.

That's why I prefer to keep any important information as close as possible, either in the commit message or as a comment in the source code, to make sure it's unmissable to anyone working on it later.

dmtry 3 hours ago|
I like git-notes (https://git-scm.com/docs/git-notes) for this sort of annotations and context. It's a nice balance - adjacent to commits, follows branch structure, easy to instrument, doesn't muddy the commit history.

Being able to stick a bit of directive text somewhere durable at any point in time has been surprisingly convenient for steering LLMs, as well.

cerved 3 hours ago|
why not both? notes are pretty ephemeral by design
More comments...