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
docs: update images and breakout links for the "bot" section of the documentation (all-contributors#919)
* docs: update images and document how to add content to our docs
docs: update images and edit text for all intro pages
docs: clean up all pages in the general overview section
docs: add description for Ideas, projectManagement and promotion (all-contributors#829)
docs: ✏️ Add dark mode README logo (all-contributors#741)
Co-authored-by: Leah Wasser <[email protected]>
Co-authored-by: Jim Madge <[email protected]>
* enh(image): bring in dark mode compatible logo
* docs: tidy adding images section
Move path alias section up and adjust
Apply suggestions from code review
Co-authored-by: Jim Madge <[email protected]>
* style: linting fixes for emoji table and other content
* docs: fix links and breakouts in bot section
* Apply suggestions from code review
Co-authored-by: Jim Madge <[email protected]>
---------
Co-authored-by: Jim Madge <[email protected]>
Co-authored-by: Jim Madge <[email protected]>
<Picturesrc={installApp}formats={['avif', 'webp']}alt="A screenshot of the GitHub interface that appears when you click the above install the bot button. It has a list of repositories and organizations that you have access to install the bot into." />
<Picturesrc={configureRepo}formats={['avif', 'webp']}alt="A screenshot showing how to configurerepositories for the AllContributors GitHub App." />
19
21
20
22
## 3. Create a `README.md`
21
23
@@ -41,9 +43,11 @@ For the list:
41
43
<!-- ALL-CONTRIBUTORS-LIST:END -->
42
44
```
43
45
44
-
Note: Extra line is very important in order to make it work properly.
46
+
<Asidetype="caution"> The extra line is to allow the bot to properly add contributors to that block in your README file.</Aside>
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.
49
+
Style, color, and other parameters can be customized to your liking — visit [shields.io](https://shields.io/) to make a custom badge.
45
50
46
-
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. Style, color, and other parameters can be customized to your liking — see <https://shields.io/>.
@@ -63,8 +67,3 @@ For the badge use the following, replacing `projectOwner` with the relevant GitH
63
67
## 4. Update your Contributing documentation
64
68
65
69
Consider updating your `CONTRIBUTING.md` or similar with steps on how contributors can add themselves. You can even link to the [bot usage documentation](usage).
[](https://github.com/all-contributors/all-contributors-bot/stargazers)
12
+
13
+
🤖 A GitHub bot to automate acknowledging contributors to your open source projects.
14
+
15
+
## How the Bot Works
16
+
17
+
Implementing the [All Contributors spec](/specification) by hand is a laborious process.
18
+
19
+
The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!
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.
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
+
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.
46
+
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.
44
47
> For example, this will work too:
45
48
>
46
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`
47
50
>
48
-
> 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.
49
-
50
-
## What's next
51
51
52
-
-[Configuring the Bot](configuration)
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