Конфигурация бота

Вы можете настроить поведение all-contributors бота, обновив .all-contributorsrc JSON файл. Данные, используемые для создания списка участников будут сохранены в этом файле, и Вы можете настроить @all-contributors для генерации списка как Вам угодно.

Вы просматриваете 🤖 Конфигурацию Бота, аналогичную CLI конфигурации

Ниже приведены ключи, которые можно задать:

Опция	Описание	Пример/По-умолчанию
`files`	Массив файлов для обновления.	По умолчанию: `['README.md']`
`imageSize`	Размер аватара пользователя (в пикселях).	По умолчанию: `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`)	По умолчанию: `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.