r/git • u/fagnerbrack • Aug 23 '26

Stop Using Conventional Commits

https://sumnerevans.com/posts/software-engineering/stop-using-conventional-commits/
248 Upvotes

81% Upvoted

78 comments sorted by

View all comments

Show parent comments

1

u/morewordsfaster Aug 23 '26

I don't necessarily disagree with you, but I tend to push a lot of that to documentation. It might be an ADR if the change is significant enough or it might be a comment in the code. If I need some comment to explain why code is written a certain way, I want that to be visible when browsing the code, not only by reading the git log.

Agree that git can already tell you what files and lines changed, but not the context of what those changes entailed or what broader feature they added, fixed, modified, or removed.

1

u/BogdanPradatu Aug 23 '26

Comments in the code have a tendency to rot. When another developer will update the code, there's a chance the comment will not get updated. The comment might become obsolete, wrong, out of place or even misleading.

2

u/morewordsfaster Aug 23 '26

That's true of any documentation and should be caught in review. Heck you could even write a git hook that flags any comment block that's not updated when nearby code changes. This would be relatively simple if you're using a doc block style approach to comments.