Skip to content
This repository was archived by the owner on Apr 30, 2018. It is now read-only.

Commit 67f1020

Browse files
author
Kent C. Dodds
committed
docs(contributing): Add new conventions to contributing docs
So people know how to commit code properly
1 parent 3ed9bf5 commit 67f1020

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,12 @@ Please do the following:
4444
1. run `npm install`
4545
2. run `npm start` (if you're on a windows machine, see [this issue](https://github.com/formly-js/angular-formly/issues/305))
4646
3. write tests & code in ES6 goodness :-)
47-
4. commit your changes to the `src/` directory only please. Also, please keep PRs changing only what the specific issue is addressing. In your commit message, add a reference to the issue it's addressing (i.e. Fixes issue with templateManipulators #153)
48-
5. notice that there's a pre-commit hook that runs to ensure tests pass and coverage doesn't drop to prevent the build from breaking :-)
49-
6. push your changes
50-
7. create a PR with a link to the original issue
51-
8. wait patiently :-)
47+
4. run `git add src/`
48+
5. run `npm run commit` and follow the prompt (this ensures that your commit message follows our guidelines).
49+
6. notice that there's a pre-commit hook that runs to ensure tests pass and coverage doesn't drop to prevent the build from breaking :-)
50+
7. push your changes
51+
8. create a PR with a link to the original issue
52+
9. wait patiently :-)
5253

5354
#### Notes
5455

@@ -66,7 +67,7 @@ There are a lot of questions from people as they get started using angular-forml
6667
- Hang out on [the chat](http://chat.angular-formly.com)
6768
- Sign up on [the mailing list](http://mailing-list.angular-formly.com)
6869
- Watch the [angular-formly repositories](https://github.com/formly-js) for issues or requests that you could help with (like [angular-formly-website](https://github.com/formly-js/angular-formly-website) for requests for examples).
69-
70+
7071
#### Contributing to community
7172

7273
- Write blog posts! Like [this one](https://scotch.io/tutorials/easy-angularjs-forms-with-angular-formly) or [this one](http://www.erwan-datin.com/tips/how-do-I-store-angular-formly-fields-model-into-database)

0 commit comments

Comments
 (0)