mirror of
https://github.com/all-contributors/cli.git
synced 2025-01-10 05:56:29 +00:00
120 lines
4.5 KiB
Markdown
120 lines
4.5 KiB
Markdown
# all-contributors-cli
|
||
|
||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->[](#contributors)<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||
|
||
This is a tool to help automate adding contributor acknowledgements according to the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
||
|
||
## Installation
|
||
|
||
You can install it via `npm`:
|
||
```console
|
||
npm install all-contributors-cli
|
||
```
|
||
|
||
## Configuration
|
||
|
||
### Create a `.all-contributorsrc` file
|
||
|
||
You must create a `.all-contributorsrc` JSON file. The data used to generate the contributors list will be stored in here, and you can configure how you want `all-contributors-cli` to generate the list.
|
||
|
||
```json
|
||
{
|
||
"files": ["README.md"],
|
||
"owner": "jfmengels",
|
||
"types": {
|
||
"cheerful": {
|
||
"symbol": ":smiley:"
|
||
}
|
||
},
|
||
"contributors": [{
|
||
"login": "jfmengels",
|
||
"...": "..."
|
||
}]
|
||
}
|
||
```
|
||
|
||
These are the keys you can specify:
|
||
- `files`: Array of files to update. Default: `['README.md']`
|
||
- `projectOwner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributor-cli` --> `jfmengels`. Mandatory.
|
||
- `projectName`: Name of the project. Example: `jfmengels/all-contributor-cli` --> `all-contributor-cli`. Mandatory.
|
||
- `types`: Specify custom symbols or link templates for contribution types. Can override the documented types.
|
||
- `imageSize`: Size (in px) of the user's avatar. Default: `100`.
|
||
- `contributorsPerLine`: Maximum number of columns for the contributors table. Default: `7`.
|
||
- `contributorTemplate`: Define your own template to generate the contributor list.
|
||
- `badgeTemplate`: Define your own template to generate the badge.
|
||
|
||
### Add contributors section
|
||
|
||
If you don't already have a Contributors section in a Markdown file, create one. Then add the comment tags section below to it. Don't worry, they're visible only to those that read the raw file.
|
||
|
||
```md
|
||
## Contributors
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||
```
|
||
|
||
If you wish to add a badge ( [](#contributors) ) indicating the number of collaborators, add the following comment tags section:
|
||
|
||
```md
|
||
some-badge
|
||
<!-- ALL-CONTRIBUTORS-BADGE:START --><!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||
some-other-badge
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Generating the contributors list
|
||
|
||
Use `generate` to generate the contributors list and inject it into your contributors file. Contributors will be read from your configuration file.
|
||
|
||
```console
|
||
all-contributors generate
|
||
```
|
||
|
||
### Add new contributor
|
||
|
||
Use `add` to add new contributors to your project. They will be added to your configuration file. The contributors file will then be updated just as if you used the `generate` command.
|
||
|
||
```console
|
||
# Add new contributor <username>, who made a contribution of type <contribution>
|
||
all-contributors add <username> <contribution>
|
||
# Example:
|
||
all-contributors add jfmengels code,doc
|
||
```
|
||
|
||
Where:
|
||
- `username` is the user's GitHub username
|
||
- `contribution` is a `,`-separated list of ways to contribute, from the following list ([see the specs](https://github.com/kentcdodds/all-contributors#emoji-key)):
|
||
- code: 💻
|
||
- plugin: 🔌
|
||
- tool: 🔧
|
||
- doc: 📖
|
||
- question: ❓
|
||
- test: ⚠️
|
||
- bug: 🐛
|
||
- example: 💡
|
||
- blog: 📝
|
||
- tutorial: ✅
|
||
- translate: 🌍
|
||
- video: 📹
|
||
- talk: 📢
|
||
- design: 🎨
|
||
- review: 👀
|
||
|
||
|
||
## Contributors
|
||
|
||
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||
| [<br /><sub>Jeroen Engels</sub>](https://github.com/jfmengels)<br />[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) [📖](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) [⚠️](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) | [<br /><sub>Kent C. Dodds</sub>](http://kentcdodds.com/)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) |
|
||
| :---: | :---: |
|
||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||
|
||
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
||
Contributions of any kind welcome!
|
||
|
||
## LICENSE
|
||
|
||
MIT
|