all-contributors-cli

This is a tool to help automate adding contributor acknowledgements according to the all-contributors specification.

Usage

all-contributors <username> <contribution>

Where:

• username is the user's GitHub username
• contribution is a ';'-separated list of ways to contribute, from the following list (see the specs):
• code: 💻
• plugin: 🔌
• tool: 🔧
• doc: 📖
• question: ❓
• test: ⚠️
• bug: 🐛
• example: 💡
• blog: 📝
• tutorial: ✅
• video: 📹
• talk: 📢
• design: 🎨

Configuration

You can configure the project by creating a .all-contributors JSON file.

{
  "file": "README.md",
  "owner": "jfmengels",
  "emoji": {
    "thoughtleadering": "some emoji"
  }
}

These are the keys you can specify:

• TODO file: File to write the list of contributors in. Default: 'README.md'
• TODO owner: Name of the user the project is hosted by. Example: jfmengels/all-contributor-cli --> jfmengels. By default will be parsed from the repo's homepage in package.json.
• TODO project: Name of the project. Default: Name of the project written in the package.json file.
• TODO imageSize: Size (in px) of the user's avatar. Default: 100.
• TODO emoji: Specify custom emoji, can override the existing override.