commitlint icon indicating copy to clipboard operation
commitlint copied to clipboard

fix: Docs missing `issuePrefixes`

Open thernstig opened this issue 1 year ago • 3 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
  • [X] 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

thernstig avatar Mar 19 '24 14:03 thernstig

Found something here: https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/parse/README.md#api

Hope this helps

escapedcat avatar Mar 20 '24 02:03 escapedcat

@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

thernstig avatar Mar 20 '24 07:03 thernstig

Happy for a PR to tackle and improve this

escapedcat avatar Mar 20 '24 08:03 escapedcat