Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
"astro": "astro",
"link-check-md": "lychee src/content/docs/**/*.md --root-dir $(pwd)/public",
"link-check-md-offline": "lychee src/content/docs/**/*.md --root-dir $(pwd)/public --offline",
"lint": "markdownlint **/*.md --ignore node_modules"
"lint": "markdownlint **/*.{md,mdx} --ignore node_modules",
"lint-fix": "markdownlint **/*.{md,mdx} --ignore node_modules --fix"
},
"dependencies": {
"@astrojs/sitemap": "^3.5.1",
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/bot/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ These are the keys you can specify:
| `files` | Array of files to update. | Default: `['README.md']` |
| `imageSize` | Size (in px) of the user's avatar. | Default: `100` |
| `commit` | Auto-commit badge when adding contributors. | Default: `false` |
| `commitConvention` | Commit convention ([`angular`](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-guidelines), [`atom`](https://github.com/atom/atom/blob/main/CONTRIBUTING.md#git-commit-messages), [`ember`](https://guides.emberjs.com/v1.10.0/contributing/#toc_commits), [`eslint`](https://eslint.org/docs/1.0.0/developer-guide/contributing#step-2-make-your-changes), [`jshint`](https://jshint.com/contribute/), [`gitmoji`](https://gitmoji.carloscuesta.me/), or `none`). | Default: `angular` |
| `commitConvention` | Commit convention ([`angular`](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit), [`atom`](https://github.com/atom/atom/blob/main/CONTRIBUTING.md#git-commit-messages), [`ember`](https://guides.emberjs.com/v1.10.0/contributing/#toc_commits), [`eslint`](https://eslint.org/docs/latest/contribute/pull-requests#step2), [`jshint`](https://jshint.com/contribute/), [`gitmoji`](https://gitmoji.carloscuesta.me/), or `none`). | Default: `angular` |
| `contributorsPerLine` | Maximum number of columns for the contributors table. | Default: `7` |
| `contributorsSortAlphabetically` | `true`: Sort alphabetically. `false`: Display in order of addition. | Default: `false` |
| `badgeTemplate` | Define your own lodash template to generate the badge. | |
Expand Down
3 changes: 1 addition & 2 deletions src/content/docs/bot/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,9 @@ For the list:

<Aside type="caution"> The extra line is to allow the bot to properly add contributors to that block in your README file.</Aside>

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.
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 — visit [shields.io](https://shields.io/) to make a custom badge.


```markdown
[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)
```
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/bot/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ import botUsage from '@assets/bot-usage.png';

Implementing the [All Contributors spec](/specification) by hand is a laborious process.

The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!
The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!

1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution.
1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution.
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.

<Picture src={botUsage} formats={['avif', 'webp']} alt="A screenshot of a github comment that says please add @user for design." />
4 changes: 2 additions & 2 deletions src/content/docs/bot/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ The bot will then create a Pull Request to add the contributor, then reply with

<Picture src={botUsage} alt="Example usage screenshot" />

### Natural Language Processing
### Natural Language Processing

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.
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.
2 changes: 1 addition & 1 deletion src/content/docs/cli/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: CLI Configuration
sidebar_label: Configuration
---

Please refer to the [bot documentation for CLI configuration information](../../bot/configuration).
Please refer to the [bot documentation for CLI configuration information](../bot/configuration).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lychee found this url issue! i wonder if there is a way to create a docs alias too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that we can the same as we do the image path, but I didn't try it 😅

2 changes: 1 addition & 1 deletion src/content/docs/cli/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Aside } from '@astrojs/starlight/components';
## 1. How to Install the All-Contributors CLI tool

The all-contributors CLI module is distributed via [npm](https://www.npmjs.com/) which is bundled with [node](https://nodejs.org/) and
should be installed as one of your project's `devDependencies`.
should be installed as one of your project's `devDependencies`.

To install it run:

Expand Down
7 changes: 4 additions & 3 deletions src/content/docs/cli/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ sidebar_label: Overview
The all-contributors-cli is a tool that helps you automate adding contributor acknowledgements for your GitHub or GitLab repository at the command line. THe GitHub bot allows you to call our bot in a issue or pull request.

You want to use the command line because:
- You want to add contributors in bulk
- You want to add contributors as part of your project scripts
- You want to add contributors as part of your continuous integration (CI) process

* You want to add contributors in bulk
* You want to add contributors as part of your project scripts
* You want to add contributors as part of your continuous integration (CI) process

Similar to the bot, the CLI allows you to implement the [All Contributors](../specification) spec, without maintaining the contributor table by hand.
11 changes: 6 additions & 5 deletions src/content/docs/cli/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,24 @@ import { Aside } from '@astrojs/starlight/components';

<Aside type="tip"> This usage documentation assumes you have already followed the [cli installation steps](installation). Below you will learn how to use the CLI with the `all-contributors` command, to keep things simple. If you are having any difficulties running the command on it's own, then give the `npx all-contributors-cli init` route a try 😺.</Aside>


## All-Contributors Command Line Interface Commands

### `all-contributors init`

You can run `all-contributors init` when you first start using the All-Contributors CLI. This command asks a you few questions. It then, sets up the project to support All-Contributors.

The setup includes creating:
* an `.all-contributorsrc` configuration file and
The setup includes creating:

* an `.all-contributorsrc` configuration file and
* a contributor table in the `files` you specify.

The default file for the contributor table is your `README.md`.

### `all-contributors add`

Use the `add` command to add:
* new contributors to your project, or

* new contributors to your project, or
* add new ways in which they have contributed.

For instance, a user may have already contributed code, but after they add a documentation pull request you might want to add them for documentation too. The contributor will be added to your configuration file, and the
Expand Down Expand Up @@ -87,4 +88,4 @@ some commands will require you to set an environment variable named `PRIVATE_TOK
export PRIVATE_TOKEN=your_private_token
# set private token on Windows
set PRIVATE_TOKEN=your_private_token
```
```
2 changes: 0 additions & 2 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,5 +142,3 @@ so you can focus on your project instead of managing your ReadMe.
<img src="https://www.netlify.com/assets/badges/netlify-badge-color-accent.svg" alt="Deploys by Netlify" />

</div>


6 changes: 2 additions & 4 deletions src/content/docs/project/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,9 @@ further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team.

We are currently working on a new COC team here at All Contributors so please bare with us as we rework our documentation and governance structures.
We are currently working on a new COC team here at All Contributors so please bare with us as we rework our documentation and governance structures.


All
complaints will be reviewed and investigated and will result in a response that
All complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality concerning the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Expand Down
Loading