Permalink
Browse files

Updated contributing document

  • Loading branch information...
1 parent ae3c243 commit 56a0c2ccd4add9d06ebbbc34e7c396d2cf174c3a @laktek committed Sep 25, 2012
Showing with 24 additions and 7 deletions.
  1. +24 −7 CONTRIBUTING.md
View
@@ -1,18 +1,35 @@
## Follow this flow to fix bugs, implement new features for Punch:
1. Fork [Punch on GitHub](http://github.com/laktek/punch):
+
2. Clone the forked repository:
+
`git clone git@github.com:YOUR_USER/punch.git && cd punch`
-3. Verify that existing tests pass:
+
+3. Verify existing tests pass:
+
`jasmine-node spec`
+
4. Create a topic branch:
+
`git checkout -b feature`
-5. **Make your changes.** (It helps a lot if you write tests first.)
-6. Verify that tests still pass:
+
+5. Read the [Coding Style Guide](https://github.com/laktek/punch/wiki/Coding-Style-Guide)
+
+6. **Make your changes.** (It helps a lot if you write tests first.)
+
+7. Verify that tests still pass:
+
`jasmine-node spec`
-7. Run JSHint and make sure you're code didn't bring in any inconsistencies:
+
+8. Run JSHint and make sure you're code didn't bring in any inconsistencies:
+
`jshint lib/*`
-8. Push to your fork:
+
+9. Push to your fork:
+
`git push -u YOUR_USER feature`
-9. Send a [pull request](https://github.com/laktek/punch/pulls) describing your changes.
-10. If possible, make sure [Punch Guide](https://github.com/laktek/punch/wiki) is up to date, after your changes were merged.
+
+10. Send a [pull request](https://github.com/laktek/punch/pulls) describing your changes.
+
+11. If possible, make sure [Punch Guide](https://github.com/laktek/punch/wiki) is up to date, after your changes were merged.

0 comments on commit 56a0c2c

Please sign in to comment.