Skip to content

Commit 6ef45b5

Browse files
atuttleBerkmann18
andauthored
docs: clarify the default sort order for both cli and bot (all-contributors#369)
* docs: ✏️ Clarify the default sort order for both cli and bot Closes: all-contributors#368 * docs: clarify contributorsSortAlphabetically * docs(configuration): consistency update Co-authored-by: Maximilian Berkmann <[email protected]>
1 parent 0dea13e commit 6ef45b5

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

docs/bot/configuration.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These are the keys you can specify:
1717
| `files` | Array of files to update. | Default: `['README.md']` |
1818
| `imageSize` | Size (in px) of the user's avatar. | Default: `100` |
1919
| `contributorsPerLine` | Maximum number of columns for the contributors table. | Default: `7` |
20-
| `contributorsSortAlphabetically` | Sort the contributors table in alphabetical order. (either `true` or `false`) | Default: `false` |
20+
| `contributorsSortAlphabetically` | `true`: Sort alphabetically. `false`: Display in order of addition. | Default: `false` |
2121
| `badgeTemplate` | Define your own lodash template to generate the badge. | |
2222
| `contributorTemplate` | Define your own lodash template to generate the contributor. | |
2323
| `types` | Specify custom symbols or link templates for contribution types. Can override the documented types. | |
@@ -43,5 +43,3 @@ These are the keys you can specify:
4343
"contributors": []
4444
}
4545
```
46-
47-

docs/cli/configuration.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ These are the keys you can specify:
2323
| `commit` | Auto-commit badge when adding contributors. | `true` or `false` |
2424
| `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/) or [`gitmoji`](https://gitmoji.carloscuesta.me/)). | Default: `none` |
2525
| `contributorsPerLine` | Maximum number of columns for the contributors table. | Default: `7` |
26-
| `contributorsSortAlphabetically` | Sort the contributors table in alphabetical order. Must be either `true` or `false`. | Default: `false` |
26+
| `contributorsSortAlphabetically` | `true`: Sort alphabetically. `false`: Display in order of addition. | Default: `false` |
2727
| `badgeTemplate` | Define your own lodash template to generate the badge. | |
2828
| `contributorTemplate` | Define your own lodash template to generate the contributor. | |
2929
| `types` | Specify custom symbols or link templates for contribution types. Can override the documented types. | |
@@ -50,5 +50,3 @@ These are the keys you can specify:
5050
"contributors": []
5151
}
5252
```
53-
54-

0 commit comments

Comments
 (0)