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

Git commit message styleguide

github.com

Post reply on HN
Print view View original

31–39 of 39 posts

Re: Git commit message styleguide

#32

Post by avian »

jwilk wrote: post #21
avian wrote: post #20

> Use Valid MarkDown format in Message Body. I like to keep Markdown away from my repos. After a while people get clever with their Markdown and it makes reading commit logs using command-line tools increasingly difficult. It also encourages writing things into commit logs that would be better suited for documentation. Edit: apparently it's not a Github specific thing.

I don't believe GitHub renders commit messages as Markdown.

I tried and you're right. Did they disable that recently? Or is there a popular IDE that does render Markdown in commit messages? I had to ask a few people not to use Markdown and I just assumed it was a Github thing.

Re: Git commit message styleguide

#36

Post by shawnee_ » 

  :globe_with_meridians:
"slashbin" = [the username of this Github user]

"*" = [the projects or repos to which this styleguide applies is not defined > /dev/null]

  :pencil:
"Use the Present Tense" == "'Use the Present Tense' is missing object. Please specify: 'Use present tense verb'"

"Rule 8 parenthetical example ()" == "Use present participle as descriptor; try 'Adding feature' NOT 'Add feature' to accurately describe what submitter does during ``git commit``"

"Use the Imperative Mood" == "Error: Imperative Mood does not map to correct structure; please check grammar and re-submit"

Re: Git commit message styleguide

#37

Post by yaccz »

pvinis wrote: post #9

Oh cool. Let's force a dev to take like 5 minutes to write a commit message. That will make all of us more productive.. If this is a joke, eh it's not a great one. If it's actually for real, might I suggest making a script for the emoji selection and the formatting of "Only One Newline"?

https://github.com/jakeasmith/commit

Re: Git commit message styleguide

#38

Post by kelnos »

Klathmon wrote: post #11
siboehm wrote: post #8

Emoji might actually be usefull for quick oversight, but how can you include a reference to an issue for every commit? What if you are just adding more tests?

I've seen this kind of thing work really well for some teams. In that case there should be a "ref" for adding tests. It tends to act as resource management, you shouldn't be working on things that your manager doesn't know about at least enough to make an "issue" for it. But it's not a 100% must in all cases, just that there SHOULD be a ref there. The rule of thumb for us was if it's going to take more than 15 minute…

> The rule of thumb for us was if it's going to take more than 15 minutes, it needs an issue.

Gross. That sounds like process for process' sake. Or you could, you know, just trust that your developers are working on actually useful things because that's what you hired them to do, and we're all professionals here, one hopes.

Maybe something like this is useful for _very_ junior developers who need a bit of hand-holding before they're steeped in how professional development in a team setting works, but if you still need this sort of thing after even a year at work, that'd be a huge red flag to me.

Re: Git commit message styleguide

#39

Post by callumlocke »

jt2190 wrote: post #29

For those who don't know, this is a joke, poking fun at the commit style sometimes used on github, versus git's recommended style. (Edit: Here's a link to a style guide in git's documentation, for example: https://www.git-scm.com/book/en/v2/Distributed-Git-Contribut... )

Are you sure it's a joke? Pretty sure it's serious
Post reply on HN