This repository has been archived by the owner on Feb 5, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(project): make project easier to contribute to (#54)
By swapping ghooks for husky, adding a CONTRIBUTING.md and adding the all-contributors table. Adding existing committers to the all-contributors table: @kentcdodds, @remy, @cmalard, @markdalgleish, @ryan-kimber, @jcollado, @jamischarles, @erquhart, @tusharmath, @bitjson, @hisabimbola, @bahmutov, @ds82, @mattlewis92, @tlvince, @adjohnson916, @zetlen, @opatut, @bmds, @emmurillo, and @Starefossen Thanks everyone! ref #53
- Loading branch information
Kent C. Dodds
committed
Dec 21, 2016
1 parent
12317ca
commit 3386784
Showing
7 changed files
with
4,034 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| { | ||
| "projectName": "validate-commit-msg", | ||
| "projectOwner": "kentcdodds", | ||
| "files": [ | ||
| "README.md" | ||
| ], | ||
| "imageSize": 100, | ||
| "commit": false, | ||
| "contributors": [ | ||
| { | ||
| "login": "kentcdodds", | ||
| "name": "Kent C. Dodds", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3", | ||
| "profile": "https://kentcdodds.com", | ||
| "contributions": [ | ||
| "question", | ||
| "code", | ||
| "doc", | ||
| "review", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "remy", | ||
| "name": "Remy Sharp", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/13700?v=3", | ||
| "profile": "http://remysharp.com", | ||
| "contributions": [ | ||
| "code", | ||
| "doc", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "cmalard", | ||
| "name": "Cédric Malard", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/1692136?v=3", | ||
| "profile": "http://valdun.net", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "markdalgleish", | ||
| "name": "Mark Dalgleish", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/696693?v=3", | ||
| "profile": "markdalgleish.com", | ||
| "contributions": [ | ||
| "doc" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "ryan-kimber", | ||
| "name": "Ryan Kimber", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/1018189?v=3", | ||
| "profile": "https://formhero.io", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "jcollado", | ||
| "name": "Javier Collado", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/43780?v=3", | ||
| "profile": "https://github.com/jcollado", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "jamischarles", | ||
| "name": "Jamis Charles", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/606014?v=3", | ||
| "profile": "https://github.com/jamischarles", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "erquhart", | ||
| "name": "Shawn Erquhart", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/2112202?v=3", | ||
| "profile": "http://www.professant.com", | ||
| "contributions": [ | ||
| "code", | ||
| "doc", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "tusharmath", | ||
| "name": "Tushar Mathur", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/194482?v=3", | ||
| "profile": "http://tusharm.com", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "bitjson", | ||
| "name": "Jason Dreyzehner", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/904007?v=3", | ||
| "profile": "https://twitter.com/bitjson", | ||
| "contributions": [ | ||
| "code", | ||
| "doc", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "hisabimbola", | ||
| "name": "Abimbola Idowu", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/9654923?v=3", | ||
| "profile": "http://twitter.com/hisabimbola", | ||
| "contributions": [ | ||
| "code" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "bahmutov", | ||
| "name": "Gleb Bahmutov", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/2212006?v=3", | ||
| "profile": "https://glebbahmutov.com/", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "ds82", | ||
| "name": "Dennis", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/332905?v=3", | ||
| "profile": "http://dennis.io", | ||
| "contributions": [ | ||
| "code" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "mattlewis92", | ||
| "name": "Matt Lewis", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/6425649?v=3", | ||
| "profile": "https://mattlewis.me/", | ||
| "contributions": [ | ||
| "code" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "tlvince", | ||
| "name": "Tom Vincent", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/323761?v=3", | ||
| "profile": "https://tlvince.com", | ||
| "contributions": [ | ||
| "code" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "adjohnson916", | ||
| "name": "Anders D. Johnson", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/615381?v=3", | ||
| "profile": "https://andrz.me/", | ||
| "contributions": [ | ||
| "code", | ||
| "doc", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "zetlen", | ||
| "name": "James Zetlen", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/1643758?v=3", | ||
| "profile": "jameszetlen.com", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "opatut", | ||
| "name": "Paul Bienkowski", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/235784?v=3", | ||
| "profile": "http://opatut.de", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "bmds", | ||
| "name": "Barney Scott", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/324073?v=3", | ||
| "profile": "https://github.com/bmds", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "Emmurillo", | ||
| "name": "Emmanuel Murillo Sánchez", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/5572221?v=3", | ||
| "profile": "https://github.com/Emmurillo", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "Starefossen", | ||
| "name": "Hans Kristian Flaatten", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/968267?v=3", | ||
| "profile": "https://starefossen.github.io", | ||
| "contributions": [ | ||
| "code", | ||
| "test" | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,3 +10,5 @@ nohup.out | |
| *.ignored.* | ||
| *.ignored/ | ||
| *.ignored | ||
| .opt-in | ||
| .opt-out | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # Contributing | ||
|
|
||
| Thanks for being willing to contribute! | ||
|
|
||
| **Working on your first Pull Request?** You can learn how from this *free* series | ||
| [How to Contribute to an Open Source Project on GitHub][egghead] | ||
|
|
||
| ## Project setup | ||
|
|
||
| You're going to need [`git`](https://git-scm.com/) to get the project, and [`node`](https://nodejs.org/en/) and | ||
| [`yarn`](https://yarnpkg.com/) to install dependencies and run scripts. | ||
|
|
||
| 1. Fork and clone the repo | ||
| 2. Run `yarn` to install dependencies | ||
| 3. Run `yarn run validate` to validate you've got everything working | ||
| 4. Create a branch for your PR | ||
|
|
||
| ## Add yourself as a contributor | ||
|
|
||
| This project follows the [all contributors][all-contributors] specification. To add yourself to the table of | ||
| contributors on the README.md, please use the automated script as part of your PR: | ||
|
|
||
| ```console | ||
| yarn run add-contributor <YOUR_GITHUB_USERNAME> | ||
| ``` | ||
|
|
||
| Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run | ||
| it again and select the added contribution type. | ||
|
|
||
| ## Committing and Pushing changes | ||
|
|
||
| This project uses [`semantic-release`][semantic-release] to do automatic releases and generate a changelog based on the | ||
| commit history. So we follow [a convention][convention] for commit messages. Please follow this convention for your | ||
| commit messages. | ||
|
|
||
| You can use `commitizen` to help you to follow [the convention][convention] | ||
|
|
||
| Once you are ready to commit the changes, please use the below commands | ||
|
|
||
| 1. Run `git add <files to be comitted>` to stage changed files | ||
| 2. Run `yarn run commit` to start commitzen to commit those files | ||
|
|
||
| ... and follow the instruction of the interactive prompt. | ||
|
|
||
| ### opt into git hooks | ||
|
|
||
| There are git hooks set up with this project that are automatically installed when you install dependencies. They're | ||
| really handy, but are turned off by default (so as to not hinder new contributors). You can opt into these by creating | ||
| a file called `.opt-in` at the root of the project and putting this inside: | ||
|
|
||
| ``` | ||
| commitmsg | ||
| precommit | ||
| ``` | ||
|
|
||
| ## Help needed | ||
|
|
||
| Please checkout [the issues](https://github.com/kentcdodds/validate-commit-msg/issues)! Also, please watch the repo | ||
| and respond to questions/bug reports/feature requests! Thanks! | ||
|
|
||
| [egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github | ||
| [semantic-release]: https://npmjs.com/package/semantic-release | ||
| [convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md | ||
| [all-contributors]: https://github.com/kentcdodds/all-contributors | ||
| [ROADMAP]: ./ROADMAP.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.