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 Usage

This usage documentation assumes you have already followed the bot installation steps.

Commands

  • @all-contributors add

@all-contributors add

Comment on Issue or Pull Request, asking @all-contributors to add a contributor:

@all-contributors please add @<username> for <contributions>

<contribution>: See the Emoji Key (Contribution Types Reference) for a list of valid contribution types.

The bot will then create a Pull Request to add the contributor, then reply with the pull request details.

Example usage screenshot

Your request to the bot doesn't need to be perfect. The bot will use basic Natural Language Parsing to determine your intent. For example, this will work too:

Jane you are crushing it in documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @all-contributors

What's next

  • Configuring the Bot
Last updated on 1/18/2021 by Josh Soref
← InstallationConfiguration →
  • Commands
    • @all-contributors add
  • What's next
All ContributorsStar All Contributors