Skip to content
This repository has been archived by the owner on Oct 21, 2020. It is now read-only.

Relax rules for commit messages #54

Closed
Bouncey opened this issue Apr 20, 2018 · 8 comments
Closed

Relax rules for commit messages #54

Bouncey opened this issue Apr 20, 2018 · 8 comments

Comments

@Bouncey
Copy link
Member

Bouncey commented Apr 20, 2018

I like the rules for commit messages, but please can we relax them.

My proposal:

$1($2): $3

$1: One of feat fix chore docs tests
$2: Any single word, any case
$3: Any string, any case

Example:

feat(types): Expand User type and apply 'on-the-fly' migrations

Reasoning:

I like to keep my commit messages consistent with the code is touches. If I fix a bug in someBuggyFunction, I want to reference it in my commit message. Or if I am working with types, I want to use StartCase in the commit message to reference the type I have worked on, which uses StartCase in the code base.

@ojongerius
Copy link
Contributor

I'm all for this.

I do see merit in having consistency in regards to a full stop, the only thing I care about is consistency. Happy to keep enforcing full stops?

@Bouncey
Copy link
Member Author

Bouncey commented Apr 20, 2018

Are we enforcing full stops? Haven't tripped that rule yet

@ojongerius
Copy link
Contributor

I'm guilty of having tripped that plenty of times, an old habit. Appears commitlint/config-conventional, which we extend, enforces subject-full-stop.

@Bouncey
Copy link
Member Author

Bouncey commented Apr 21, 2018

So, are we saying

  • full stop - yes
    or
  • full stop - no

??

@ojongerius
Copy link
Contributor

Let's keep the default of "full stop - no".

@user512
Copy link
Contributor

user512 commented May 13, 2018

May I work on this? My assumption to config the subject-case rule. (http://marionebl.github.io/commitlint/#/reference-rules?id=subject-case)

@ojongerius
Copy link
Contributor

All yours @user512 !

user512 added a commit to user512/open-api that referenced this issue May 13, 2018
Allow commit message to be consistent with code changed

ISSUES CLOSED: freeCodeCamp#54
user512 added a commit to user512/open-api that referenced this issue May 13, 2018
Allow commit message to be consistent with code changed

ISSUES CLOSED: freeCodeCamp#54
user512 added a commit to user512/open-api that referenced this issue May 13, 2018
Allow commit message to be consistent with code changed

ISSUES CLOSED: freeCodeCamp#54
user512 added a commit to user512/open-api that referenced this issue May 13, 2018
Allow commit message to be consistent with code changed

ISSUES CLOSED: freeCodeCamp#54
user512 added a commit to user512/open-api that referenced this issue May 13, 2018
Allow commit message to be consistent with code changed

ISSUES CLOSED: freeCodeCamp#54
@user512
Copy link
Contributor

user512 commented May 13, 2018

@Bouncey I tested the PR with your example commit message and returns no error/ warning.

ojongerius pushed a commit that referenced this issue May 13, 2018
Allow commit message to be consistent with code changed

ISSUES CLOSED: #54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants