Official website: allcontributors.org
| English | 中文 |
|---|---|
| README.md | README-zh-CN.md |
Ⅰ.Install from NPM
yarn add --dev all-contributors-cli
# OR
npm i -D all-contributors-cli
Ⅱ.Init the Project
yarn all-contributors init
# Or
npm run all-contributors init
# Or directly execute the bin
./node_modules/.bin/all-contributors init
Ⅲ.Add some contributors
# Add new contributor <username>, who made a contribution of type <contribution>
all-contributors add <username> <contribution>
# Example:
# all-contributors add jfmengels code,doc
# generate table
yarn all-contributors generate
NOTE1：Before generate
Use generate to read the contributors list from your .all-contributorsrc file and update the contributor tables specified by the files key.
Please note the command must be able to find the following tags in those files, in order to update the table:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
♥ The code above will be modified as runing yarn all-contributors generate , please delete contents between the first tag and the last one.
NOTE2：Emoji Key ✨ (and Contribution Types)
| Emoji/Type | Represents | Comments |
|---|---|---|
| 💬 | ||
question |
Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc. |
| 🐛 | ||
bug |
Bug reports | links to issues reported by the user on this project |
| 📝 | ||
blog |
Blogposts | links to the blogpost |
| 💼 | ||
business |
Business Development | people who execute on the business end |
| 💻 | ||
code |
Code | links to commits by the user on this project |
| 🖋 | ||
content |
Content | e.g. website copy, blog posts are separate |
| 📖 | ||
doc |
Documentation | links to commits by the user on this project, Wiki, or other source of documentation |
| 🎨 | ||
design |
Design | links to the logo/iconography/visual design/etc. |
| 💡 | ||
example |
Examples | links to the examples |
| 📋 | ||
eventOrganizing |
Event Organizers | links to event page |
| 💵 | ||
financial |
Financial Support | people or orgs who provide financial support, links to relevant page |
| 🔍 | ||
fundingFinding |
Funding/Grant Finders | people who help find financial support |
| 🤔 | ||
ideas |
Ideas & Planning | |
| 🚇 | ||
infra |
Infrastructure | Hosting, Build-Tools, etc. Links to source file (like travis.yml) in repo, if applicable |
| 🚧 | ||
maintenance |
Maintenance | people who help in maintaining the repo, links to commits by the user on this project |
| 📦 | ||
platform |
Packaging | porting to support a new platform |
| 🔌 | ||
plugin |
Plugin/utility libraries | links to the repo home |
| 📆 | ||
projectManagement |
Project Management | |
| 👀 | ||
review |
Reviewed Pull Requests | |
| 🛡️ | ||
security |
Security | identify and/or reduce security threats, GDPR, Privacy, etc |
| 🔧 | ||
tool |
Tools | links to the repo home |
| 🌍 | ||
translation |
Translation | links to the translated content |
| ⚠️ | ||
test |
Tests | links to commits by the user on this project |
| ✅ | ||
tutorial |
Tutorials | links to the tutorial |
| 📢 | ||
talk |
Talks | links to the slides/recording/repo/etc |
| 📓 | ||
userTesting |
User Testing | links to user test notes |
| 📹 | ||
video |
Videos | links to the video |
Ⅳ.Update your Contributing documentation
Consider updating your .all-contributorsrc or similar with steps on how your contributors can add themselves.
Ⅴ.Optionally add shortcut scripts to your package.json
You can optionally add shortcuts to your commands in your package.json scripts field.
For example:
{
"scripts": {
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate"
}
}
To allow shortcuts such as
yarn contributors:add jfmengels doc
Contributors ✨
Thanks goes to these wonderful people (emoji key):
 Allenem 💻 📖 🌍 |
 ionicbond-lzj ⚠️ |
 Juliayao 📓 |
This project follows the all-contributors specification. Contributions of any kind welcome!
