Install the Bot

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

1. 安装AllContributors GitHub应用

   安装 GitHub 应用

   

2. 配置你的仓库

   

3. 创建 README.md

   确保项目根目录中包括 README.md 文件（可以为空）。

   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

   Make sure to add this in the markdown:

   For the list:

   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 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. 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 :

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