From 6bf8e8f89e3d6613c046de3eb8cf1ef8503801bc Mon Sep 17 00:00:00 2001 From: Dan Ott Date: Tue, 31 Oct 2023 10:35:15 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Add=20commitType?= =?UTF-8?q?=20to=20config=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add the commitType key and description to the configuration table ✅ Closes: all-contributors/all-contributors#710 --- docs/bot/configuration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/bot/configuration.md b/docs/bot/configuration.md index 13b61428..fb9111e4 100644 --- a/docs/bot/configuration.md +++ b/docs/bot/configuration.md @@ -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` | | `contributorsPerLine` | Maximum number of columns for the contributors table. | Default: `7` | | `contributorsSortAlphabetically` | `true`: Sort alphabetically. `false`: Display in order of addition. | Default: `false` | | `badgeTemplate` | Define your own lodash template to generate the badge. | |