Docs: parserOpts and headerPattern need detailed docs
#3,336 建立於 2022年8月24日
倉庫指標
- 星標
- (15,497 顆星)
- PR 合併指標
- (平均合併 12小時 56分鐘) (30 天內合併 52 個 PR)
描述
We use modified version of conventional commits standard on the project and we start use commitlint.
Today i've found problem with config of commitlint and tried to found any info about how to fix it, i've read docs site https://commitlint.js.org and i totally can't found nothing useful information. This site just list availavle option names and examples, but not explain meaning of each option.
It seems that we need to configure parserOpts object and set headerPattern regular expression to parse our commit message, but commitlint just not provide explaining what is this, how it works and how we can use it for our purposes.
We have to improve docs and add descriptions about this, otherwise this powerful tool just useless for developers, because instead of safe our time, it's just take away our time to explore source code of this tool. Right now this tool looks not reliable.
Could you please tell us how many time you need to improve docs?