ボットの設定 · All Contributors

.all-contributorsrc JSON ファイルからall-contributorsボットの設定を変更できます。コントリビューターリストを生成するためのデータはそのファイルに格納されています。また、all-contributors-cliでどのようにリストを生成するのかの設定も変更できます。

これはボット設定に関するページです。CLI設定をお探しですか？

指定できるキーは以下のとおりです:

オプション	説明	例/デフォルト
`files`	更新対象のファイル配列	デフォルト: `['README.md']`
`imageSize`	ユーザーアバターのサイズ (px)	デフォルト: `100`
`contributorsPerLine`	コントリビューターテーブルの最大カラム数	デフォルト: `7`
`contributorsSortAlphabetically`	`true`: Sort alphabetically. `false`: Display in order of addition.	Default: `false`
`badgeTemplate`	バッジを生成するための独自のlodashテンプレート定義
`contributorTemplate`	コントリビューターを生成するための独自のlodashテンプレート定義
`types`	コントリビュータータイプのカスタムシンボルかリンクテンプレートの指定。記述されたタイプを上書き可能
`skipCi`	Makes the CI ignore the commit. (either `true` or `false`)	Default: `true`
`contributors`	プロジェクトのコントリビューターリスト、@all-contributors addで更新される

{
  "files": ["README.md"],
  "imageSize": 100,
  "contributorsPerLine": 7,
  "contributorsSortAlphabetically": false,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
  "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
  "types": {
    "custom": {
      "symbol": "🔭",
      "description": "A custom contribution type.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "skipCi": "true",
  "contributors": []
}

Moving the All Contributors table into a different file

As you know, the default file for the contributors table is README.md. But if your project has tons of contributors, it doesn't make sense to include the All Contributors table in the README.md file. Instead, you can use a different file to do so.

Here are the steps that may help you in achieving that. For the sake of this tutorial, the different file that we'll use is going to be named CONTRIBUTORS.md.

Install the bot. See the Installation page for instructions.
Add your first contributor. See the Bot Usage page for instructions.
Create the CONTRIBUTORS.md file.

Copy the code from the Contributors section in the README.md file, starting at the ALL-CONTRIBUTORS-LIST:START line, and ending at the ALL-CONTRIBUTORS-LIST:END line.

Example:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
  <td align="center">...</td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Modify the files key in the .all-contributorsrc JSON file to match your new file name.
```
{
"files": [
  "CONTRIBUTORS.md"
],
...
}
```
Now you should be good to go. New contributors will be added to this new file instead of the README.md file.