fix: Docs missing `issuePrefixes`
thernstig opened this issue · comments
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
Found something here: https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/parse/README.md#api
Hope this helps
@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.
Happy for a PR to tackle and improve this