Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: Commit Comments – build commit messages in code comments

github.com

Post reply on HN
Print view View original

1–10 of 28 posts

Re: Show HN: Commit Comments – build commit messages in code comments

#3

Post by WorldMaker »

cphoover wrote: post #2

What advantage does this have over git blame view?

Presumably the impetus is that if you fix a bunch of small things in a single commit it might be easier to compile the list of small things you changed by noting them as comments as you fix them rather than trying to remember them after the fact when it comes time to write a commit log for that commit.

That said, philosophically I'd personally prefer to just commit the small features individually as a set of small commits, therefore you get a better git blame/praise experience with the end result, but I realize there is a wide spectrum of preferences on commit size and style.

Re: Show HN: Commit Comments – build commit messages in code comments

#6

Post by Zezima »

WorldMaker wrote: post #3
cphoover wrote: post #2

What advantage does this have over git blame view?

Presumably the impetus is that if you fix a bunch of small things in a single commit it might be easier to compile the list of small things you changed by noting them as comments as you fix them rather than trying to remember them after the fact when it comes time to write a commit log for that commit. That said, philosophically I'd personally prefer to just commit the small features individually as a set of small co…

Yes, that was my intention when making this project. I prefer the practice of making very small changes and committing frequently with opulent use of branches.

However, many of my peers and co-workers have a hard time following the small-commit workflow, so this project is really for them.

Being able to mark small (but significant) changes in your code as you code definitely helps reduce some ambiguity in commit messages.

Re: Show HN: Commit Comments – build commit messages in code comments

#7

Post by jedberg »

Presumably this is so you don't forget about a bunch of small changes when making a large commit. However, for me, right before I do a commit, I always do a diff to make sure what I'm about to commit is what I intended to, which has the nice side effect of seeing all the changes and reminding me for the commit message.

Is this not the common way most people commit?

Re: Show HN: Commit Comments – build commit messages in code comments

#8

Post by joncalhoun »

Zezima wrote: post #6
WorldMaker wrote: post #3

Earlier quoted context omitted.

Presumably the impetus is that if you fix a bunch of small things in a single commit it might be easier to compile the list of small things you changed by noting them as comments as you fix them rather than trying to remember them after the fact when it comes time to write a commit log for that commit. That said, philosophically I'd personally prefer to just commit the small features individually as a set of small co…

Yes, that was my intention when making this project. I prefer the practice of making very small changes and committing frequently with opulent use of branches. However, many of my peers and co-workers have a hard time following the small-commit workflow, so this project is really for them. Being able to mark small (but significant) changes in your code as you code definitely helps reduce some ambiguity in commit mess…

Some feedback on that regard - if you could note line numbers or anything really w/ some of these it would probably help more than just messages. Eg "Concatenated strings in HelloWorld.js#12"

Re: Show HN: Commit Comments – build commit messages in code comments

#10

Post by joncalhoun »

jedberg wrote: post #7

Presumably this is so you don't forget about a bunch of small changes when making a large commit. However, for me, right before I do a commit, I always do a diff to make sure what I'm about to commit is what I intended to, which has the nice side effect of seeing all the changes and reminding me for the commit message. Is this not the common way most people commit?

I believe this is a pretty common thing based on personal experience.
Post reply on HN