You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/bot/installation.mdx
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,10 +45,9 @@ For the list:
45
45
46
46
<Asidetype="caution"> The extra line is to allow the bot to properly add contributors to that block in your README file.</Aside>
47
47
48
-
For the badge use the following, replacing `projectOwner` with the relevant GitHub username or organization name, and `projectName` with the relevant the GitHub repo name.
48
+
For the badge use the following, replacing `projectOwner` with the relevant GitHub username or organization name, and `projectName` with the relevant the GitHub repo name.
49
49
Style, color, and other parameters can be customized to your liking — visit [shields.io](https://shields.io/) to make a custom badge.
Copy file name to clipboardExpand all lines: src/content/docs/bot/overview.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ import botUsage from '@assets/bot-usage.png';
16
16
17
17
Implementing the [All Contributors spec](/specification) by hand is a laborious process.
18
18
19
-
The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!
19
+
The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!
20
20
21
-
1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution.
21
+
1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution.
22
22
2. Once you do this, the bot will automatically pull a user's profile image, grab the contribution type emoji, update the project README file with the new contributors and then open a Pull Request against the project.
23
23
24
24
<Picturesrc={botUsage}formats={['avif', 'webp']}alt="A screenshot of a github comment that says please add @user for design." />
Your request to the bot doesn't need to be perfect. The bot will use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/main/lib/parse-comment.js) to determine your intent.
47
47
> For example, this will work too:
48
48
>
49
49
> `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 @all-contributors`
50
50
>
51
51
52
-
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.
52
+
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.
0 commit comments