Skip to content
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

Closed
dijonkitchen opened this issue Nov 23, 2017 · 14 comments
Closed

Case of commit messages #24

dijonkitchen opened this issue Nov 23, 2017 · 14 comments
Assignees
Labels
Milestone

Comments

@dijonkitchen
Copy link
Contributor

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

@stevemao
Copy link
Member

It was defined by the angular convention spec.

@dijonkitchen
Copy link
Contributor Author

dijonkitchen commented Nov 27, 2017

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.

@stevemao
Copy link
Member

I guess it's just easy to type. no particular reason. But good to have consistency.

@dijonkitchen
Copy link
Contributor Author

I figure the best practice if we're setting a standard is capitalized.

For example:

Build(npm): Upgrade npm version

@bcoe
Copy link
Contributor

bcoe commented Mar 16, 2018

@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.

@bcoe bcoe added the triaged label Mar 16, 2018
@dijonkitchen
Copy link
Contributor Author

Sure, that makes sense to me! Though I think uppercase looks better for readability, the parser for the changelog should be agnostic!

@stevemao
Copy link
Member

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.

@damianopetrungaro
Copy link
Member

I prefer lowercase too, do we need something for this?

@hutson
Copy link
Contributor

hutson commented Jul 16, 2018

My two cents:

  • Parser should not care.
  • Capitalization should be enforceable per-project through commitlint.
  • Format of changelogs should be opinionated/consistent.
  • commitlint defaults should align with default of Conventional Commits.

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?

@hutson
Copy link
Contributor

hutson commented Aug 19, 2018

To move this forward, should we add an item to the FAQ that acknowledges that any casing may be used?

@hutson hutson added support and removed triaged labels Aug 19, 2018
@damianopetrungaro
Copy link
Member

@hbetts Yup, totally agree with it!
@dijonkitchen do you want to work on it?

@damianopetrungaro damianopetrungaro added this to the 1.0.0-beta.3 milestone Aug 20, 2018
dijonkitchen added a commit to dijonkitchen/conventionalcommits.org that referenced this issue Aug 20, 2018
@dijonkitchen
Copy link
Contributor Author

Boom! ☝️

@mlindner
Copy link

This is utterly broken. Please study https://chris.beams.io/posts/git-commit/#capitalize

@annanyearian
Copy link

  1. Capitalize the subject line

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.

Fix(Reporting): Change CIFS read failure code to correct READ_ERR
Fix(reporting): Change CIFS read failure code to correct READ_ERR
fix(reporting): Change CIFS read failure code to correct READ_ERR
fix(reporting): change cifs read failure code to correct READ_ERR

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

7 participants