mirror of
https://github.com/all-contributors/cli.git
synced 2025-01-09 21:46:29 +00:00
Add kentcdodds to contributors
This commit is contained in:
parent
ff7457c825
commit
5949ac389b
2 changed files with 67 additions and 42 deletions
|
@ -1,16 +1,27 @@
|
||||||
{
|
{
|
||||||
"projectOwner": "jfmengels",
|
"projectOwner": "jfmengels"
|
||||||
"projectName": "all-contributors-cli",
|
, "projectName": "all-contributors-cli"
|
||||||
"imageSize": 100,
|
, "imageSize": 100
|
||||||
"contributors": [{
|
, "contributors": [
|
||||||
"login": "jfmengels",
|
{
|
||||||
"name": "Jeroen Engels",
|
"login": "jfmengels"
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/3869412?v=3",
|
, "name": "Jeroen Engels"
|
||||||
"html_url": "https://github.com/jfmengels",
|
, "avatar_url": "https://avatars.githubusercontent.com/u/3869412?v=3"
|
||||||
"contributions": [
|
, "html_url": "https://github.com/jfmengels"
|
||||||
"code",
|
, "contributions": [
|
||||||
"doc",
|
"code"
|
||||||
"test"
|
, "doc"
|
||||||
]
|
, "test"
|
||||||
}]
|
]
|
||||||
|
}
|
||||||
|
, {
|
||||||
|
"login": "kentcdodds"
|
||||||
|
, "name": "Kent C. Dodds"
|
||||||
|
, "avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3"
|
||||||
|
, "html_url": "http://kentcdodds.com/"
|
||||||
|
, "contributions": [
|
||||||
|
"doc"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|
70
README.md
70
README.md
|
@ -9,32 +9,6 @@ You can install it via `npm`:
|
||||||
npm install all-contributors-cli
|
npm install all-contributors-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```
|
|
||||||
# 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: ✅
|
|
||||||
- video: 📹
|
|
||||||
- talk: 📢
|
|
||||||
- design: 🎨
|
|
||||||
- review: 👀
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Add contributing section
|
### Add contributing section
|
||||||
|
@ -77,14 +51,54 @@ These are the keys you can specify:
|
||||||
- `contributorsPerLine`: Maximum number of columns for the contributors table. Default: 7.
|
- `contributorsPerLine`: Maximum number of columns for the contributors table. Default: 7.
|
||||||
- `template`: Define your own template to generate the contributor list.
|
- `template`: Define your own template to generate the contributor list.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
```
|
||||||
|
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.
|
||||||
|
|
||||||
|
```
|
||||||
|
# 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
|
## Contributors
|
||||||
|
|
||||||
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
|
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
|
||||||
|
|
||||||
<!-- CONTRIBUTORS:START - Do not remove or modify this section -->
|
<!-- CONTRIBUTORS:START - Do not remove or modify this section -->
|
||||||
| [![Jeroen Engels](https://avatars.githubusercontent.com/u/3869412?v=3&s=100)<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) |
|
| [![Jeroen Engels](https://avatars.githubusercontent.com/u/3869412?v=3&s=100)<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) | [![Kent C. Dodds](https://avatars.githubusercontent.com/u/1500684?v=3&s=100)<br /><sub>Kent C. Dodds</sub>](http://kentcdodds.com/)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) |
|
||||||
| :---: |
|
| :---: | :---: |
|
||||||
<!-- CONTRIBUTORS:END -->
|
<!-- CONTRIBUTORS:END -->
|
||||||
|
|
||||||
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
||||||
|
|
Loading…
Reference in a new issue