Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
35 lines (21 sloc) 1.09 KB
id title sidebar_label
installation
Bot Installation
Installation

1. Install the AllContributors GitHub App

Install the GitHub App

App Install Screenshot

2. Configure your repositories

Configure Repositories Screenshot

3. Create a README.md

Ensure you have a README.md file in 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

4. Update your Contributing documentation

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

What's next

You can’t perform that action at this time.