Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: Rules and documents do not match each other #3340

Closed
lidigobeyond opened this issue Aug 26, 2022 · 1 comment · Fixed by #3341
Closed

docs: Rules and documents do not match each other #3340

lidigobeyond opened this issue Aug 26, 2022 · 1 comment · Fixed by #3341

Comments

@lidigobeyond
Copy link
Contributor

lidigobeyond commented Aug 26, 2022

Expected Behavior

According to the content here: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#subject-case, the subject-case always be either sentence-case, start-case, pascal-case, or upper-case.
If it's not, commitlint must throw an error.

Current Behavior

But commitlint throw an error when subject-case is either sentence-case, start-case, pascal-case, or upper-case.

> echo "fix: SOMEMESSAGE" | commitlint
⧗   input: fix: SOMEMESSAGE
✖   subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Rule and document do not match each other

Possible Solution

Please fix the documentation appropriately like below.

subject-case

  • condition: subject is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
  • rule: never ✨✨
  • level: error
echo "fix(SCOPE): Some message" # fails
echo "fix(SCOPE): Some Message" # fails
echo "fix(SCOPE): SomeMessage" # fails
echo "fix(SCOPE): SOMEMESSAGE" # fails
echo "fix(scope): some message" # passes
echo "fix(scope): some Message" # passes
@escapedcat
Copy link
Member

What config do you use?
Happy for a PR here if you have time.

# for free to join this conversation on GitHub. Already have an account? # to comment
Development

Successfully merging a pull request may close this issue.

2 participants