All Contributors

All Contributors

  • Docs
  • GitHub
  • Languages iconEnglish
    • 日本語
    • Deutsch
    • Español
    • Français
    • Bahasa Indonesia
    • 한국어
    • Polski
    • Português (Brasil)
    • Русский
    • 中文

›@all-contributors Bot 🤖

Specification

  • Overview
  • Specification
  • Emoji Key ✨
  • Repository Maintainers
  • Tooling

@all-contributors Bot 🤖

  • Overview
  • Installation
  • Usage
  • Configuration
  • FAQs

CLI

  • Overview
  • Installation
  • Usage
  • Configuration

Project

  • Help us Improve
  • Code of Conduct
  • Who's using it?
Edit

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

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

  • Using the Bot
  • Configuring the Bot
Last updated on 1/11/2022 by JohnnySD
← OverviewUsage →
  • 1. Install the AllContributors GitHub App
  • 2. Configure your repositories
  • 3. Create a README.md
  • 4. Update your Contributing documentation
  • What's next
All ContributorsStar All Contributors