You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm not sure why the docs/readme would be different from the conventional-config readme.
Without any config you need to write your own config anyways. So there's no commitlint-"default".
I'm learning about the configuration of some rules. And I found
subject-case
's configuration is inconsistent in different README.md.Expected Behavior
According to @commitlint/config-conventional/index.js, the default values of
subject-case
are['sentence-case', 'start-case', 'pascal-case', 'upper-case']
.Current Behavior
In docs/reference-rules.md:

And In @commitlint/config-conventional/README.md:

The
condition
,rule
andvalue
are inconsistent.Possible Solution
I have a suggestion to modify these two files as follows:
docs/reference-rules.md
subject-case
subject
is in one of the cases['sentence-case', 'start-case', 'pascal-case', 'upper-case']
always
@commitlint/config-conventional/README.md:
subject-case
subject
is in one of the cases['sentence-case', 'start-case', 'pascal-case', 'upper-case']
always
error
Your Environment
commitlint --version
git --version
node --version
Can I send PR for this? Thanks for taking note of this question.
The text was updated successfully, but these errors were encountered: