Install the Bot

This guide explains how you can add the All Contributors bot to your project.

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

   Install the GitHub App

   

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

   

3. Create a README.md

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

   If you prefer your contributors table in a place other than the README.md; After merging your first bot PR, you can move your contributors table, see files in the bot configuration

   Не забудьте добавить это в разметку:

   Для списка:

   README.md

   ## 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 -->

   Осторожно

   The extra line is to allow the bot to properly add contributors to that block in your README.md file.

   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 — visit shields.io to make a custom badge.

   README.md

   [![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. Для начала в нем может быть только обязательная информация. Бот обновит его автоматически с конфигурацией по умолчанию в первом PR.> Here is the minimal .all-contributorsrc file to add in your repo :

   .all-contributorsrc

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

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

   Consider updating your CONTRIBUTING.md or similar with steps on how contributors can add themselves. You can even link to the bot usage documentation.