Giter Club home page Giter Club logo

Comments (14)

hutson avatar hutson commented on August 22, 2024 3

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?

from conventionalcommits.org.

dijonkitchen avatar dijonkitchen commented on August 22, 2024 2

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

For example:

Build(npm): Upgrade npm version

from conventionalcommits.org.

bcoe avatar bcoe commented on August 22, 2024 2

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

from conventionalcommits.org.

hutson avatar hutson commented on August 22, 2024 2

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

from conventionalcommits.org.

dijonkitchen avatar dijonkitchen commented on August 22, 2024 2

Boom! ☝️

from conventionalcommits.org.

stevemao avatar stevemao commented on August 22, 2024 1

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

from conventionalcommits.org.

damianopetrungaro avatar damianopetrungaro commented on August 22, 2024 1

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

from conventionalcommits.org.

mlindner avatar mlindner commented on August 22, 2024 1

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

from conventionalcommits.org.

stevemao avatar stevemao commented on August 22, 2024

It was defined by the angular convention spec.

from conventionalcommits.org.

dijonkitchen avatar dijonkitchen commented on August 22, 2024

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.

from conventionalcommits.org.

dijonkitchen avatar dijonkitchen commented on August 22, 2024

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

from conventionalcommits.org.

stevemao avatar stevemao commented on August 22, 2024

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.

from conventionalcommits.org.

damianopetrungaro avatar damianopetrungaro commented on August 22, 2024

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

from conventionalcommits.org.

annanyearian avatar annanyearian commented on August 22, 2024
  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.

from conventionalcommits.org.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.