Skip to content

Commit

Permalink
feat(types): add/update contrib types (#24)
Browse files Browse the repository at this point in the history
* feat(types): add/update contrib types

To "upgrade" to the latest specification.

* fix: linting issues

* test: Update question emoji in tests (#27)

* Update format-contribution-type.test.js

Updated the expected question emoji.

* Update format-contributor.test.js

Updated the expected question emoji.

* Add @itaisteinherz as a contributor

* generate

* add code

* doc: Add new contribution types to README.md (#26)

* Update README.md

Added the new contribution types to accommodate #24.

* Add @itaisteinherz as a contributor

* regenerate
  • Loading branch information
Kent C. Dodds authored and jfmengels committed Jan 25, 2017
1 parent 806894e commit 8fd4098
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 9 deletions.
13 changes: 12 additions & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3",
"profile": "http://kentcdodds.com/",
"contributions": [
"doc"
"doc",
"code"
]
},
{
Expand All @@ -41,6 +42,16 @@
"contributions": [
"code"
]
},
{
"login": "itaisteinherz",
"name": "Itai Steinherz",
"avatar_url": "https://avatars.githubusercontent.com/u/22768990?v=3",
"profile": "https://github.com/itaisteinherz",
"contributions": [
"doc",
"code"
]
}
]
}
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# all-contributors-cli

[![version](https://img.shields.io/npm/v/all-contributors-cli.svg)](http://npm.im/all-contributors-cli)[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)
[![version](https://img.shields.io/npm/v/all-contributors-cli.svg)](http://npm.im/all-contributors-cli)[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors)

This is a tool to help automate adding contributor acknowledgements according to the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.

Expand Down Expand Up @@ -56,18 +56,22 @@ Where `username` is the user's GitHub username, and `contribution` is a `,`-sepa
- code: 💻
- plugin: 🔌
- tool: 🔧
- infra: 🚇
- doc: 📖
- question: ❓
- translate: 🌍
- question: 💬
- test: ⚠️
- bug: 🐛
- example: 💡
- blog: 📝
- tutorial: ✅
- translate: 🌍
- video: 📹
- talk: 📢
- design: 🎨
- review: 👀
- financial: 💵
- fundingFinding: 🔍
- eventOrganizing: 📋

## Configuration

Expand All @@ -88,8 +92,8 @@ These are the keys you can specify:
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
| [<img src="https://avatars.githubusercontent.com/u/3869412?v=3" width="100px;"/><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) | [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub>Kent C. Dodds</sub>](http://kentcdodds.com/)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) | [<img src="https://avatars.githubusercontent.com/u/14871650?v=3" width="100px;"/><br /><sub>João Guimarães</sub>](https://github.com/jccguimaraes)<br />[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jccguimaraes) | [<img src="https://avatars.githubusercontent.com/u/1282980?v=3" width="100px;"/><br /><sub>Ben Briggs</sub>](http://beneb.info)<br />[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=ben-eb) |
| :---: | :---: | :---: | :---: |
| [<img src="https://avatars.githubusercontent.com/u/3869412?v=3" width="100px;"/><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) | [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub>Kent C. Dodds</sub>](http://kentcdodds.com/)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) [💻](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) | [<img src="https://avatars.githubusercontent.com/u/14871650?v=3" width="100px;"/><br /><sub>João Guimarães</sub>](https://github.com/jccguimaraes)<br />[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=jccguimaraes) | [<img src="https://avatars.githubusercontent.com/u/1282980?v=3" width="100px;"/><br /><sub>Ben Briggs</sub>](http://beneb.info)<br />[💻](https://github.com/jfmengels/all-contributors-cli/commits?author=ben-eb) | [<img src="https://avatars.githubusercontent.com/u/22768990?v=3" width="100px;"/><br /><sub>Itai Steinherz</sub>](https://github.com/itaisteinherz)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=itaisteinherz) [💻](https://github.com/jfmengels/all-contributors-cli/commits?author=itaisteinherz) |
| :---: | :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
Expand Down
2 changes: 1 addition & 1 deletion lib/generate/format-contribution-type.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ test('should return corresponding symbol', t => {
const {options} = fixtures();

t.is(formatContributionType(options, contributor, 'tool'), '🔧');
t.is(formatContributionType(options, contributor, 'question'), '💁');
t.is(formatContributionType(options, contributor, 'question'), '💬');
});

test('should return link to commits', t => {
Expand Down
2 changes: 1 addition & 1 deletion lib/generate/format-contributor.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ test('should format contributor with complex contribution types', t => {
const contributor = contributors.kentcdodds;
const {options} = fixtures();

const expected = '[<img src="https://avatars1.githubusercontent.com/u/1500684" width="150px;"/><br /><sub>Kent C. Dodds</sub>](http://kentcdodds.com)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) 👀 💁';
const expected = '[<img src="https://avatars1.githubusercontent.com/u/1500684" width="150px;"/><br /><sub>Kent C. Dodds</sub>](http://kentcdodds.com)<br />[📖](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) 👀 💬';

t.is(formatContributor(options, contributor), expected);
});
Expand Down
14 changes: 13 additions & 1 deletion lib/util/contribution-types.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var defaultTypes = {
description: 'Plugin/utility libraries'
},
question: {
symbol: '💁',
symbol: '💬',
description: 'Answering Questions'
},
review: {
Expand Down Expand Up @@ -73,6 +73,18 @@ var defaultTypes = {
video: {
symbol: '📹',
description: 'Videos'
},
financial: {
symbol: '💵',
description: 'Financial'
},
fundingFinding: {
symbol: '🔍',
description: 'Funding Finding'
},
eventOrganizing: {
symbol: '📋',
description: 'Event Organizing'
}
};

Expand Down

0 comments on commit 8fd4098

Please sign in to comment.