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

Mismatch in documentation and source code #4244

Open
1 of 4 tasks
austinnamesnik opened this issue Jan 13, 2025 · 1 comment
Open
1 of 4 tasks

Mismatch in documentation and source code #4244

austinnamesnik opened this issue Jan 13, 2025 · 1 comment

Comments

@austinnamesnik
Copy link

Steps to Reproduce

Link to the docs:
https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-conventional/README.md#subject-case

Link to the source code:
https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-conventional/src/index.ts#L22


The same applies to the Angular config package.

Link to the docs:
https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-angular/README.md#subject-case

Link to the source code:
https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-angular/index.js#L13

Current Behavior

The rules in the docs specify the cases are enforced to be used, though the source says the cases are enforced to not be used.

Currently the cases aren't allowed in the subject.

Expected Behavior

I would expect the cases to be allowed in the subject of the commits, because the docs say so.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

Either change the docs or the source to both have 'always' or 'never'.

Context

I am trying to write commits according to the specification in the docs, but am confronted with errors.

commitlint --version

@commitlint/cli@19.6.1

git --version

git version 2.39.5 (Apple Git-154)

node --version

v22.9.0

@escapedcat
Copy link
Member

Sorry, can't follow. Can you elaborate what you are doing? I.e. provide (shell-)commands and (commitlint-)config. Thanks

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

No branches or pull requests

2 participants