Edit

Установка Бота

1. Установите AllContributors GitHub приложение

Установить GitHub приложение

Скриншот установки приложения

2. Настройте ваши репозитории

Скриншот настройки репозиториев

3. Создайте README.md

Ensure you have a README.md file at the root of the project (it can be empty).

Если вы предпочитаете, чтобы таблица с участниками располагалась в месте, отличном от README.md; После слияния вашего первого пулла ботом, вы можете переместить таблицу участников: смотрите files в конфигурации бота.

Make sure to add this in the markdown:

For the list:

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

Note: Extra line is very important in order to make it work properly.

For the badge use the following, replacing projectOwner with the relevant GitHub username or organization name, and projectName with the relevant the GitHub repo name. Style, color, and other parameters can be customized to your liking — see https://shields.io/.

[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)

Please create the .all-contributorsrc file for the first configuration. It can only have the mandatory information in it to begin. The bot will update it automatically with default config in the first PR. Here is the minimal .all-contributorsrc file to add in your repo :

{
  "projectName": "<insert the repo's name>",
  "projectOwner": "<insert the repo's owner/orgs>"
}

4. Обновите свою документацию для участников

Подумайте об обновлении вашего CONTRIBUTING.md файла (или подобного) пошагово о том, как участники могут добавить себя. Вы также можете обратиться к документации по использованию бота.

Дальше

← ОбзорИспользование →