Top
Best
New

Posted by yedhukrishnan 5 hours ago

Commit description as a thinking tool(yedhu.me)
102 points | 58 commentspage 2
seunosewa 4 hours ago|
I use a different LLM family to review commits and write detailed descriptions. If a commit was written with Fable/Opus, I use Sol/Astra to write a well reasoned commit message. If the message doesn't match my intent, then that triggers a manual review.
loopmonster 4 hours ago||
If the second LLM is just describing the content of the commit doesn't that defeat the purpose of the description, to capture the context that doesn't make it to the code?
seunosewa 4 hours ago||
The second LLM is prompted to actually research the code, not just the diff, with fresh eyes to figure out what it does and why, before writing the commit message.
GrinningFool 3 hours ago||
But the code doesn't always have the answer to "why". At best that means the commit-writer has 'guessed' at why.
dennisy 4 hours ago|||
This would have an even greater loss of the “why” context the author is describing in the piece.
seunosewa 1 hour ago||
The human knows the "why", so they can correct the commit message if it is wrong or incomplete. Most of the time, though, they don't have to do that.
bigmadshoe 4 hours ago|||
This makes no sense to me. The code is already self-documenting if written well, and all you need is a one line commit message to summarize that.

Doesn't the original conversation at least retain the context about why the change was made? A different LLM literally has no way to tell why you made this change besides guessing from the codebase and git history.

seunosewa 3 hours ago|||
If a change makes sense, a different frontier model can usually figure out why it was made from the code alone. I take that as a signal that that the commit is good.

I believe they can do this due to having millions of public pull requests and github issues in their training data.

cerved 3 hours ago|||
There's pretty much always several plausible reasons for why a change was made. What's interesting is knowing exactly which one, especially when it later turns out to be wrong!
bigmadshoe 2 hours ago|||
What a change does is self documenting. Why it was made and why that specific approach was chosen could be due to many things, such as:

* business objectives,

* the result of experimentation,

* the result of an offline conversation

etc.

This cannot be captured in code alone. This is why we write commit messages.

sigbottle 4 hours ago|||
the mechanism is self documenting; context is not unless you pollute all your files with an ADR's worth of alternatives.
_verandaguy 4 hours ago|||
The blog post is advocating against this.
cerved 4 hours ago||
If you ask an LLM to write a message that explains "the why", it'll make up a why.
tombert 4 hours ago||
Tangential, but very early in my career, back when I was still using SVN at work, I used to write all my commits in either limerick or haiku, usually smuggling in some curse word(s) with some cheeky message in there. I was convinced that no one actually read them and I could get a laugh out of it.

I did this for months without anyone noticing, and eventually my manager schedules a very awkward meeting asking me why I wrote saying “cfquery fucking blows sometimes”. I had to sheepishly explain that I thought it was funny and then I stopped doing that and my commits became much more utilitarian and much less fun.

blmarket 4 hours ago|
I would encourage to speak up - especially when we're blaming bad code(not a person) being bad. Ultimately senior engineers are ones who can blame bad things with a compelling reason.

Happy to read good reasoning why it's fucking blow-up.

tombert 4 hours ago||
This was a long time ago so I can't remember the details, and I was decidedly not a senior engineer at the time. That said, if I remember correctly there was something a bit finnicky with how `cfquery` in ColdFusion handled the automatic caching stuff.
FLeXMurphy 4 hours ago||
This has been a topic belabored since commit messages were a thing. CVS? RCS? Probably earlier.
cerved 3 hours ago||
Claude tends to just narrate the change when it writes the commit message. Which is not very interesting. Anyone can read the diff and figure out _what_ it does. The interesting is why.

So I've been instructing Claude to commit like Jeff King.

At first, Claude would mainly just cosplay Peff. Emulate the prose and not the process. Over the last few months I've been iterating on it and now Claude writes vastly better commit message than by default.

Initially, Claude would produce A LOT of plausible sounding reasons the LLM "thought" made sense. Instruct an LLM to give reason and it'll give you reasons -- whether they are real or not. After trying to instruct it not to lie, make shit up etc (which did not work) I instead started forcing it to articulate the source of the rationales. Especially which claims where unsubstantiated, and this seems to have helped a lot.

Then I instructed it to do some thorough investigation before it commits.

Start by writing a brief that gathers different "evidence" that underpins a change. The diff itself. The surrounding context. A bit short git log. A blame on the touched lines to see what previous commits touched this code and for what reasons.

Once it's done the agent has to tag each claim according to a category. I.e. what claims are attributed to the change itself (the diff), the inciting incident (gathered from session or if missing, by follow-up questions), what's inferred by the model (unsubstantiated claims.)

Only after this supersize is it tasked with writing a commit message given this brief. Or to ask follow-up questions if there's only unsubstantiated claims or gaps in the brief. Furthermore, it is tasked with writing a note to detail assumptions it has made and, or other relevant bits of information that are not commit message worthy, but possibly still interested in noting down. Decisions made. Options not taken. Possible rationales for the change that didn't make the cut.

All of this tends to make pretty good commit messages. Not perfect, but a good starting point.

Right now my biggest challenge is finding instructions to write the Goldilocks message. Not too brief and not too long. Instruct it to be clear and concise and relevant information gets left out. Say nothing and get a Dostoevsky novel. At least when it writes too long messages it's easy enough to go in afterwards with a `git history reword` and take out the axe.

One of the biggest upsides has been, just as when you read a human that writes commit messages like this, is spotting misunderstandings. Several times I've spotted gaps in the reasoning of the message that doesn't match reality, and caught mistakes. A bit like when you use plan mode.

fg137 1 hour ago|
Claude has been so bad that I find it easier to hand write commit messages and PR description. It works much better than nudging Claude to write things down in a readable and meaningful way.
sublinear 4 hours ago||
This problem has nothing to do with git.

The journaling of any iterative process requires clear notes that answer "why?" for each step. This is what will guide future maintenance.

Writing code faster than you can digest and explain it is at odds with this. You will incur runaway technical debt. This was already a problem long before the LLM era.

It is nice that more people are finally realizing this, but I'm still waiting for when we start speaking in generalities again and get over all the hype. Nothing ages writing faster than bringing up the specific tools.

ajuc 2 hours ago||
The comments and commit messages AI writes is often worse than useless, it's misleading, because it spreads the (very likely to get outdated) implementation details from one place to another.

I'll ask AI to write integration between 3 services, and it'll write the class names from the service A in comments in service B and C if I'm not careful.

einpoklum 3 hours ago||
> Now we are in the era of agentic coding, where everything from code to commit descriptions is written by AI.

No, we are not. Sure, there is a lot of slop-coding/vibe-coding going on, but not much of it in serious code. In my experience and to my knowledge.

Of course, I encounter the opposite problem with humans: They often don't bother to write proper commit messages; and many tend to squash them in favor of giant single-commits which just say "Implemented feature #123".

kayashaolu2 3 hours ago||
[flagged]
helloimgkeep 4 hours ago||
[dead]
JaumeGar 3 hours ago|
[flagged]