docs: add commitType to configuration docs
#757
Conversation
Add the commitType key and description to the configuration table ✅ Closes: all-contributors#710
|
@all-contributors please add @danieltott for doc |
|
I've put up a pull request to add @danieltott! 🎉 |
There was a problem hiding this comment.
@danieltott Thanks for contributing. Please check the requested changes.
danieltott
force-pushed
the
danieltott-add-committype
branch
from
4bfbf76
to
6bf8e8f
Compare
|
@tenshiAMD broken links commit pulled out and added to #759 👍🏼 |
tenshiAMD
changed the title
commitType to configuration docscommitType to configuration docs
| @@ -22,6 +22,7 @@ These are the keys you can specify: | |||
| | `imageSize` | Size (in px) of the user's avatar. | Default: `100` | | |||
| | `commit` | Auto-commit badge when adding contributors. | Default: `false` | | |||
| | `commitConvention` | Commit convention ([`angular`](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines), [`atom`](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages), [`ember`](https://guides.emberjs.com/v1.10.0/contributing/#toc_commits), [`eslint`](https://eslint.org/docs/1.0.0/developer-guide/contributing#step-2-make-your-changes), [`jshint`](https://jshint.com/contribute/), [`gitmoji`](https://gitmoji.carloscuesta.me/), or `none`). | Default: `angular` | | |||
| | `commitType` | Set the `tag` for the commit in your chosen `commitConvention` (read more at [`commit-conv`](https://github.com/Berkmann18/commit-conv#parameters)) | Default: `docs` | | |||
There was a problem hiding this comment.
Is this link right? It doesn't look like the right repo, and includes little/no helpful information about which options can be used for the commitType option.
Would https://www.conventionalcommits.org be better?
Can anyone add information about whether the it is supported to add a scope to commitType as well?
e.g. will "commitType": "chore(contributors)" work?
There was a problem hiding this comment.
I see, that's the library that the all contributors bot uses, presumably. In that case, makes sense, though it's unclear how opinionated that library is about the commitType or if any string value would be accepted.
What:
commitTypefield added to.all-contributorsrc, and all I could find about it was this issueWhy:
Having all possible configuration options listed on the configuration docs seems like a good call.
How:
I looked through the source to see how
commitTypewas being used, then wrote some descriptions for it.Checklist:
Bot Usage