Bot Usage

Note

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

Adding contributions

Comment on Issue or Pull Request asking @allcontributors to add a new contributor, or add contributions to an existing contributor:

@allcontributors please add @<username> for <contribution>

Tip

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

You can add multiple contribution types in a single comment by listing them. For example:

@allcontributors please add @<username> for <contribution>, <contribution>, and <contribution>

Caution

Use one comment per contributor you wish to add.

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

Natural Language Processing

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 the documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @allcontributors

The bot will work best in parsing your comment correctly if you precede the contributor’s username with @ as shown above. Otherwise, the bot may not correctly identify the user.