-
Notifications
You must be signed in to change notification settings - Fork 556
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Case of commit messages #24
Comments
It was defined by the angular convention spec. |
I looked at the Angular commit convention but couldn't find a reason why though. The only thing I could guess would be that it's easier to parse, but lowercase looks off as the start of all the Subject lines. |
I guess it's just easy to type. no particular reason. But good to have consistency. |
I figure the best practice if we're setting a standard is capitalized. For example:
|
@stevemao @dijonkitchen joining this conversation late ... could we make our default parser for conventional commit messages not care about case? seems like it's not something worth being opinionated about. |
Sure, that makes sense to me! Though I think uppercase looks better for readability, the parser for the changelog should be agnostic! |
I'm not opposing anyone here :) I see more people typing lower cased sentences in the commit messages in general. Also I've always wanted tools like conventional-changelog auto capitalise the first letter in a sentence. |
I prefer lowercase too, do we need something for this? |
My two cents:
As for whether the type, and first word of the summary, should be capitalized, I have no opinion on one way or another. Can someone do a quick grep over GitHub to find what's commonly used? |
To move this forward, should we add an item to the FAQ that acknowledges that any casing may be used? |
@hbetts Yup, totally agree with it! |
Boom! ☝️ |
This is utterly broken. Please study https://chris.beams.io/posts/git-commit/#capitalize |
Even trying to follow existing git best practices it's not clear to me if the subject line includes the type and scope like some people here suggest. If you treat type and scope as technical constants then the initial capital should be at start of the sentence after the colon.
Having acronyms lowercase looks strange, but so does starting a sentence with lowercase change. The original angular does thankfully have acronyms and proper nouns capitalised. Currently I use 2nd line above, but thinking to change to 3. |
Why does the spec have lowercase as the default? I figure as a title for a commit, it'd be uppercase.
Reference:
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
The text was updated successfully, but these errors were encountered: