Skip to content
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
1f11d0c
chore(ci): add dependabot config for actions (#865)
lwasser Sep 1, 2025
07db72b
chore(ci): bump actions/checkout from 3 to 5 (#883)
dependabot[bot] Sep 1, 2025
0432bf2
chore(ci): bump actions/setup-node from 3 to 4 (#882)
dependabot[bot] Sep 1, 2025
a0eafac
chore(ci): bump actions/upload-pages-artifact from 3 to 4 (#881)
dependabot[bot] Sep 3, 2025
82bee99
chore(branch rename): rename master --> main throughout so ci runs an…
lwasser Sep 4, 2025
01a00f9
docs: ✏️ fix links to doc site and small bug in footer.js (#871)
lwasser Sep 4, 2025
5524a3b
docs: add JimMadge as a contributor for review (#892)
allcontributors[bot] Sep 4, 2025
0d6d713
docs: add JHWelch as a contributor for doc (#894)
allcontributors[bot] Sep 4, 2025
5dd72d5
docs: add lwasser as a contributor for review (#897)
allcontributors[bot] Sep 5, 2025
6282070
docs: add JimMadge as a contributor for infra (#896)
allcontributors[bot] Sep 5, 2025
9f39151
docs: ✏️ Add dark mode README logo (#741)
JHWelch Sep 5, 2025
3cfb11b
docs: add RichLewis007 as a contributor for bug, and doc (#906)
allcontributors[bot] Sep 9, 2025
94d45ea
docs: add parthamk as a contributor for doc (#909)
allcontributors[bot] Sep 9, 2025
c317a70
docs: add rebeccaringuette as a contributor for ideas (#910)
allcontributors[bot] Sep 9, 2025
8b66658
Change build branch from 'master' to 'docs-upgrade'
lwasser Sep 9, 2025
390ff3f
docs: add description for Ideas, projectManagement and promotion (#829)
reshamas Sep 13, 2025
4b7f90e
docs: add KhushiPandey8 as a contributor for doc (#918)
allcontributors[bot] Sep 13, 2025
68b8d2f
docs: add lwasser as a contributor for doc (#921)
allcontributors[bot] Sep 16, 2025
76ca8c4
docs: add JimMadge as a contributor for doc (#922)
allcontributors[bot] Sep 16, 2025
a08dcf2
chore(ci): fix merge conflicts
lwasser Sep 19, 2025
38e9baf
chore(ci): fix merge conflicts from origin/main
lwasser Sep 19, 2025
53471fa
docs: linting fix
lwasser Sep 19, 2025
823b06b
docs: remove last docusaurus files
lwasser Sep 23, 2025
c9b443b
docs: update
lwasser Sep 23, 2025
45f0e31
docs: merge commit to fix conflict after moving contribute.md
lwasser Sep 23, 2025
cefc811
chore: fix linting step to handle mdx
lwasser Sep 23, 2025
ee47658
chore: lint
lwasser Sep 23, 2025
81aba31
fix: links
lwasser Sep 23, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -1040,7 +1040,9 @@
"avatar_url": "https://avatars.githubusercontent.com/u/7649194?v=4",
"profile": "http://www.leahwasser.com",
"contributions": [
"security"
"security",
"review",
"doc"
]
},
{
Expand All @@ -1049,7 +1051,8 @@
"avatar_url": "https://avatars.githubusercontent.com/u/153130183?v=4",
"profile": "https://mysiteintro.netlify.app/",
"contributions": [
"translation"
"translation",
"doc"
]
},
{
Expand All @@ -1067,7 +1070,9 @@
"avatar_url": "https://avatars.githubusercontent.com/u/23616154?v=4",
"profile": "https://blog.jmadge.com",
"contributions": [
"review"
"review",
"infra",
"doc"
]
},
{
Expand All @@ -1078,6 +1083,34 @@
"contributions": [
"doc"
]
},
{
"login": "RichLewis007",
"name": "Rich Lewis",
"avatar_url": "https://avatars.githubusercontent.com/u/1149213?v=4",
"profile": "https://github.com/RichLewis007",
"contributions": [
"bug",
"doc"
]
},
{
"login": "parthamk",
"name": "Partha Mallick",
"avatar_url": "https://avatars.githubusercontent.com/u/110169184?v=4",
"profile": "http://parthamallick.com",
"contributions": [
"doc"
]
},
{
"login": "rebeccaringuette",
"name": "Rebecca Ringuette",
"avatar_url": "https://avatars.githubusercontent.com/u/49281118?v=4",
"profile": "https://github.com/rebeccaringuette",
"contributions": [
"ideas"
]
}
],
"repoType": "github",
Expand Down
8 changes: 4 additions & 4 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,24 +62,24 @@ workflows:
filters:
branches:
only:
- master
- main
- publish_release:
requires:
- node_modules
filters:
branches:
only:
- master
- main
- check_404s:
requires:
- publish_release
filters:
branches:
only:
- master
- main

experimental:
notify:
branches:
only:
- master
- main
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
commit-message:
prefix: "chore(ci)"
6 changes: 3 additions & 3 deletions .github/workflows/build-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- uses: /actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0
- uses: actions/setup-node@v4
- uses: actions/setup-node@dbe1369d7be17e7823f8c1ee1ae8bec5779239dd # v3.9.0
with:
node-version: 23
cache: npm
Expand All @@ -25,7 +25,7 @@ jobs:
ls dist/

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
with:
path: dist/
deploy:
Expand All @@ -41,4 +41,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@f33f41b675f0ab2dc5a6863c9a170fe83af3571e # v4.0.0
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,16 @@ Thanks go to these wonderful people ([emoji key](https://allcontributors.org/doc
<td align="center" valign="top" width="14.28%"><a href="https://github.com/VitorCodes"><img src="https://avatars.githubusercontent.com/u/15626985?v=4?s=100" width="100px;" alt="Vitor Silva"/><br /><sub><b>Vitor Silva</b></sub></a><br /><a href="#translation-VitorCodes" title="Translation">🌍</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://flpm.dev"><img src="https://avatars.githubusercontent.com/u/17676929?v=4?s=100" width="100px;" alt="Felipe Moreno"/><br /><sub><b>Felipe Moreno</b></sub></a><br /><a href="#translation-flpm" title="Translation">🌍</a> <a href="https://github.com/all-contributors/all-contributors/commits?author=flpm" title="Code">💻</a> <a href="https://github.com/all-contributors/all-contributors/commits?author=flpm" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://piyushpamnani.github.io/Piyush-Portfolio/"><img src="https://avatars.githubusercontent.com/u/87657297?v=4?s=100" width="100px;" alt="Piyush Pamnani"/><br /><sub><b>Piyush Pamnani</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/commits?author=PiyushPamnani" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.leahwasser.com"><img src="https://avatars.githubusercontent.com/u/7649194?v=4?s=100" width="100px;" alt="Leah Wasser"/><br /><sub><b>Leah Wasser</b></sub></a><br /><a href="#security-lwasser" title="Security">🛡️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://mysiteintro.netlify.app/"><img src="https://avatars.githubusercontent.com/u/153130183?v=4?s=100" width="100px;" alt="Khushi"/><br /><sub><b>Khushi</b></sub></a><br /><a href="#translation-KhushiPandey8" title="Translation">🌍</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.leahwasser.com"><img src="https://avatars.githubusercontent.com/u/7649194?v=4?s=100" width="100px;" alt="Leah Wasser"/><br /><sub><b>Leah Wasser</b></sub></a><br /><a href="#security-lwasser" title="Security">🛡️</a> <a href="https://github.com/all-contributors/all-contributors/pulls?q=is%3Apr+reviewed-by%3Alwasser" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/all-contributors/all-contributors/commits?author=lwasser" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://mysiteintro.netlify.app/"><img src="https://avatars.githubusercontent.com/u/153130183?v=4?s=100" width="100px;" alt="Khushi"/><br /><sub><b>Khushi</b></sub></a><br /><a href="#translation-KhushiPandey8" title="Translation">🌍</a> <a href="https://github.com/all-contributors/all-contributors/commits?author=KhushiPandey8" title="Documentation">📖</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="http://elmthomas.com"><img src="https://avatars.githubusercontent.com/u/58678?v=4?s=100" width="100px;" alt="Eric Thomas"/><br /><sub><b>Eric Thomas</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/commits?author=et" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://blog.jmadge.com"><img src="https://avatars.githubusercontent.com/u/23616154?v=4?s=100" width="100px;" alt="Jim Madge"/><br /><sub><b>Jim Madge</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/pulls?q=is%3Apr+reviewed-by%3AJimMadge" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://blog.jmadge.com"><img src="https://avatars.githubusercontent.com/u/23616154?v=4?s=100" width="100px;" alt="Jim Madge"/><br /><sub><b>Jim Madge</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/pulls?q=is%3Apr+reviewed-by%3AJimMadge" title="Reviewed Pull Requests">👀</a> <a href="#infra-JimMadge" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/all-contributors/all-contributors/commits?author=JimMadge" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://jordanwelch.com/"><img src="https://avatars.githubusercontent.com/u/4480375?v=4?s=100" width="100px;" alt="Jordan Welch"/><br /><sub><b>Jordan Welch</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/commits?author=JHWelch" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/RichLewis007"><img src="https://avatars.githubusercontent.com/u/1149213?v=4?s=100" width="100px;" alt="Rich Lewis"/><br /><sub><b>Rich Lewis</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/issues?q=author%3ARichLewis007" title="Bug reports">🐛</a> <a href="https://github.com/all-contributors/all-contributors/commits?author=RichLewis007" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://parthamallick.com"><img src="https://avatars.githubusercontent.com/u/110169184?v=4?s=100" width="100px;" alt="Partha Mallick"/><br /><sub><b>Partha Mallick</b></sub></a><br /><a href="https://github.com/all-contributors/all-contributors/commits?author=parthamk" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rebeccaringuette"><img src="https://avatars.githubusercontent.com/u/49281118?v=4?s=100" width="100px;" alt="Rebecca Ringuette"/><br /><sub><b>Rebecca Ringuette</b></sub></a><br /><a href="#ideas-rebeccaringuette" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
</tbody>
</table>
Expand Down
24 changes: 24 additions & 0 deletions docs/assets/logo-full.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions docs/bot/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: usage
title: Bot Usage
sidebar_label: Usage
---

> This usage documentation assumes you have already followed the [bot installation steps](installation).

## Commands

<AUTOGENERATED_TABLE_OF_CONTENTS>

### `@all-contributors add`

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

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

Also, you can now add multiple contributors at the same time:

##### Using single line

```plaintext
@all-contributors please add @<username> for <contributions>. please add @<username> for <contributions>.
```
##### Using multiple lines

```plaintext
@all-contributors
please add @<username> for <contributions>.
please add @<username> for <contributions>.
```

**\<contribution>**: See the [Emoji Key (Contribution Types Reference)](../emoji-key) 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.

<img alt="Example usage screenshot" src="../../assets/bot-usage.png" width="500px">

> 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.
> 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 @all-contributors`
>
> 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.

## What's next

- [Configuring the Bot](configuration)
Loading