Remix.run Logo
lelandbatey 10 hours ago

Sounds like you haven't been working long enough to forget your decisions, which you WILL do eventually. In such cases, where you're looking at code you wrote 10 years ago and you find a weird line, when you view the git blame and read the commit message, you'll be very thankful that you explain not just "what" you did, but "why" you did this, something an AI will have a very hard time doing.

You don't have to if you don't want to, but if you think "this commit message is just a summary of the changes made", you'll never write a useful commit message.

ekropotin 9 hours ago | parent | next [-]

I’ve been working in the industry for two decades, and I think commit messages is not the best place for storing decisions and associated context. I personally prefer ADRs.

g-b-r 6 hours ago | parent [-]

Two decades and you don't see any value in writing down what's currently in your head?

Anyhow, ADRs are good, but they stand for Architectural decisions, not every decision is at that level.

In general, if there's a better place to store explanations, do use it, but often, in many projects, commit messages are the least bad place; and it's enormously better to write there than nowhere at all.

sroussey 9 hours ago | parent | prev [-]

That’s why you put the comment in the code

lexicality 4 minutes ago | parent [-]

comments rot as the code changes around them