Official website: https://allcontributors.org
English | 中文 |
---|---|
README.md | README-zh-CN.md |
Thanks goes to these wonderful people (emoji key):
蒲尧 💻 📖 🌍 👀 |
ionicbond-lzj |
Juliayao 📓 |
This project follows the all-contributors specification. Contributions of any kind welcome!
yarn add --dev all-contributors-cli
# OR
npm i -D all-contributors-cli
yarn all-contributors init
# Or
npm run all-contributors init
# Or directly execute the bin
./node_modules/.bin/all-contributors init
# 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
Consider updating your .all-contributorsrc
or similar with steps on how your contributors can add themselves.
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
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 -->
♥ I found the code above may be modified as runing yarn all-contributors generate
if they are first appearent in this article, please move contents between the first tag and the last one to the proper area Contributors.
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 |
You can configure all-contributors by updating the .all-contributorsrc
JSON file. The data used to generate the contributors list will be stored in there, and you can configure how you want all-contributors-cli
to generate the list.
These are the keys you can specify:
Option | Description | Example/Default |
---|---|---|
projectName |
Mandatory, name of the project. | Example: all-contributors-cli |
projectOwner |
Mandatory, name of the user the project is hosted by. | Example: jfmengels |
repoType |
Type of repository. Must be either github or gitlab . |
Default: github |
repoHost |
Points to the repository hostname. Change it if you use a self-hosted repository. | Default: https://github.com if repoType is github , and https://gitlab.com if repoType is gitlab |
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. | true or false |
commitConvention |
Commit convention (angular , atom , ember , eslint , jshint or gitmoji ). |
Default: none |
contributorsPerLine |
Maximum number of columns for the contributors table. | Default: 7 |
badgeTemplate |
Define your own lodash template to generate the badge. | |
contributorTemplate |
Define your own lodash template to generate the contributor. | |
types |
Specify custom symbols or link templates for contribution types. Can override the documented types. | |
contributors |
List of contributors for this project, this is updated by all-contributors add |