Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add commitType to configuration docs #757

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+1 −0
Open

docs: add commitType to configuration docs #757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/bot/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tenshiAMD perhaps you know ☝🏻

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

| `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. | |
Expand Down