Skip to content

Commit ebb402e

Browse files
committed
docs(contributing): add CONTRIBUTING with all-contributors instructions
1 parent b737ec5 commit ebb402e

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
## `all-contributors`
4+
5+
If your name or contributions are missing from the README, or if you contributed in ways not captured by the current role emojis, please create an issue and use:
6+
7+
```
8+
@all-contributors please add @githubuser for ...
9+
```
10+
11+
Then list appropriate contribution types from [allcontributors.org/docs/en/emoji-key](https://allcontributors.org/docs/en/emoji-key) (e.g., code, review, doc, content, bug, ideas, infra).
12+
13+
Alternatively, you can update it from the command line. This may be preferable, as the bot will create GitHub issues that email people when they are added.
14+
15+
You'll need to install the [All-Contributors CLI tool](https://allcontributors.org/cli/installation/):
16+
17+
```
18+
npm i -D all-contributors-cli
19+
```
20+
21+
When we first set-up all-contributors, we called:
22+
23+
```
24+
npx all-contributors init
25+
```
26+
27+
From then on, you can then run the following and select/enter relevant information when prompted:
28+
29+
```
30+
npx all-contributors
31+
```
32+
33+
If you want to remove specific contributions or people, edit the `.all-contributorsrc` file then run the following to regenerate the table in `README.md`. (Don't edit `README.md`, as it is just generated based on `.all-contributorsrc`).
34+
35+
```
36+
npx all-contributors generate
37+
```

0 commit comments

Comments
 (0)