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

fix: Docs missing issuePrefixes #3987

Open
1 of 4 tasks
thernstig opened this issue Mar 19, 2024 · 3 comments
Open
1 of 4 tasks

fix: Docs missing issuePrefixes #3987

thernstig opened this issue Mar 19, 2024 · 3 comments

Comments

@thernstig
Copy link

thernstig commented Mar 19, 2024

Steps to Reproduce

The only place in the docs I can find this is in the example at https://commitlint.js.org/reference/examples.html. But that does explain what it is and what it does, and how to enforce specific issue/ticket numbers, even though one can guess.

Current Behavior

No response

Expected Behavior

There should be some documentation explaining issuePrefixes and how it can be used.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

No response

commitlint --version

17.4.2

git --version

2.25.1

node --version

v20.10.0

@escapedcat
Copy link
Member

@thernstig
Copy link
Author

@escapedcat it does, but the problem is that this is not visible on the webpage anywhere at https://commitlint.js.org/

I feel it is something that should go into https://commitlint.js.org/reference/configuration.html.

image

@escapedcat
Copy link
Member

Happy for a PR to tackle and improve this

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