all-contributors-cli 🤖

Automate acknowledging contributors to your open source projects

, who made a contribution of type all-contributors add # Example: all-contributors add jfmengels code,doc ``` Where `username` is the user's GitHub username, and `contribution` is a `,`-separated list of ways to contribute, from the following list ([see the specs](https://github.com/kentcdodds/all-contributors#emoji-key)): * blog: [📝](# "Blogposts") * bug: [🐛](# "Bug reports") * code: [💻](# "Code") * design: [🎨](# "Design") * doc: [📖](# "Documentation") * eventOrganizing: [📋](# "Event Organizing") * example: [💡](# "Examples") * financial: [💵](# "Financial") * fundingFinding: [🔍](# "Funding Finding") * ideas: [🤔](# "Ideas, Planning, & Feedback") * infra: [🚇](# "Infrastructure (Hosting, Build-Tools, etc)") * platform: [📦](# "Packaging/porting to new platform") * plugin: [🔌](# "Plugin/utility libraries") * question: [💬](# "Answering Questions") * review: [👀](# "Reviewed Pull Requests") * talk: [📢](# "Talks") * test: [⚠️](# "Tests") * tool: [🔧](# "Tools") * translation: [🌍](# "Translation") * tutorial: [✅](# "Tutorials") * video: [📹](# "Videos") ### Check for missing contributors Use `check` to compare contributors from GitHub with the ones credited in your `.all-contributorsrc` file, in order to make sure that credit is given where it's due. ```console all-contributors check ``` > Due to GitHub API restrictions, this command only works for projects with less > than 500 contributors. ## Configuration You can configure the project 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: * `files`: Array of files to update. Default: `['README.md']` * `projectOwner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributors-cli` --> `jfmengels`. Mandatory. * `projectName`: Name of the project. Example: `jfmengels/all-contributors-cli` --> `all-contributors-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. ## Contributors Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): | [
_{Jeroen Engels}](https://github.com/jfmengels)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels "Code") [📖](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels "Documentation") [⚠️](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels "Tests") | [
_{Kent C. Dodds}](http://kentcdodds.com/)
[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds "Documentation") [💻](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds "Code") | [
_{João Guimarães}](https://github.com/jccguimaraes)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jccguimaraes "Code") | [
_{Ben Briggs}](http://beneb.info)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=ben-eb "Code") | [
_{Itai Steinherz}](https://github.com/itaisteinherz)
[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=itaisteinherz "Documentation") [💻](https://github.com/jfmengels/all-contributors-cli/commits?author=itaisteinherz "Code") | [
_{Alex Jover}](https://github.com/alexjoverm)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=alexjoverm "Code") [📖](https://github.com/jfmengels/all-contributors-cli/commits?author=alexjoverm "Documentation") | [
_{Jerod Santo}](https://jerodsanto.net)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jerodsanto "Code") | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | [
_{Kevin Jalbert}](https://github.com/kevinjalbert)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=kevinjalbert "Code") | [
_tunnckoCore](https://i.am.charlike.online)
[🔧](#tool-charlike "Tools") | [
_{Mehdi Achour}](https://machour.idk.tn/)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=machour "Code") | [
_{Roy Revelt}](https://codsen.com)
[🐛](https://github.com/jfmengels/all-contributors-cli/issues?q=author%3Arevelt "Bug reports") | [
_{Chris Vickery}](https://github.com/chrisinajar)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=chrisinajar "Code") | [
_{Bryce Reynolds}](https://github.com/brycereynolds)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=brycereynolds "Code") | [
_{James, please}](http://www.jmeas.com)
[🤔](#ideas-jmeas "Ideas, Planning, & Feedback") [💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jmeas "Code") | | [
_{Spyros Ioakeimidis}](http://www.spyros.io)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=spirosikmd "Code") | [
_{Fernando Costa}](https://github.com/fadc80)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=fadc80 "Code") | [
_snipe](https://snipe.net)
[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=snipe "Documentation") | [
_{Gant Laborde}](http://gantlaborde.com/)
[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=GantMan "Code") | This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome! ## LICENSE MIT [npm]: https://www.npmjs.com/ [node]: https://nodejs.org [build-badge]: https://img.shields.io/travis/jfmengels/all-contributors-cli.svg?style=flat-square [build]: https://travis-ci.org/jfmengels/all-contributors-cli [coverage-badge]: https://img.shields.io/codecov/c/github/jfmengels/all-contributors-cli.svg?style=flat-square [coverage]: https://codecov.io/github/jfmengels/all-contributors-cli [version-badge]: https://img.shields.io/npm/v/all-contributors-cli.svg?style=flat-square [package]: https://www.npmjs.com/package/all-contributors-cli [downloads-badge]: https://img.shields.io/npm/dm/all-contributors-cli.svg?style=flat-square [downloads]: http://www.npmtrends.com/all-contributors-cli [license-badge]: https://img.shields.io/npm/l/all-contributors-cli.svg?style=flat-square [license]: https://github.com/jfmengels/all-contributors-cli/blob/master/other/LICENSE [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square [prs]: http://makeapullrequest.com [coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square [coc]: https://github.com/jfmengels/all-contributors-cli/blob/master/other/CODE_OF_CONDUCT.md [github-watch-badge]: https://img.shields.io/github/watchers/jfmengels/all-contributors-cli.svg?style=social [github-watch]: https://github.com/jfmengels/all-contributors-cli/watchers [github-star-badge]: https://img.shields.io/github/stars/jfmengels/all-contributors-cli.svg?style=social [github-star]: https://github.com/jfmengels/all-contributors-cli/stargazers [twitter]: https://twitter.com/intent/tweet?text=Check%20out%20all-contributors-cli!%20https://github.com/jfmengels/all-contributors-cli%20%F0%9F%91%8D [twitter-badge]: https://img.shields.io/twitter/url/https/github.com/jfmengels/all-contributors-cli.svg?style=social [emojis]: https://github.com/kentcdodds/all-contributors#emoji-key [all-contributors]: https://github.com/kentcdodds/all-contributors