Comment by smallpipe

8 months ago

Shouldn’t that be the commit message ? Or is the goal to also link forward in time, such as “we realised this commit introduced bug #123” ?

5 comments

smallpipe

Reply
b0a04gl  8 months ago

haha wait do you actually read long commit messages( more than a line) all the way through? like line-by-line, imo commit msg = tweet, git note = blog post.

  • smallpipe  8 months ago

    In my line of work a bug could cost multiple millions. I do read them. I write long ones. I would love if my colleagues started writing longer ones too.

    • Ayesh  8 months ago

      Me too.

      Most of the times, the commit message is 10+ lines while the change itself is -1/+1.

      We use GitHub for repo hosting and a separate issue tracker to coordinate changes. It bothers me a lot that GitHub UI doesn't render markdown for commit messages. We all write really detailed and nicely formatted commit messages, and had to work out a commit message sync so the issue tracker can display related commit messages in full Markdown glory.

  • scubbo  8 months ago

    If you don't expect people to read commit messages, why would you expect that they'd read notes?

  • mojifwisi  8 months ago

    That seems more complicated than just adding the info in the commit message. It's not like Git doesn't have flags for trimming commit messages when reading them (--oneline).