Skip to content
Browse files

Add contributing.md

  • Loading branch information...
1 parent 9de4eb4 commit 6c54c4b04153844c0f5ab2e108114e17a5a3032a @paulmillr paulmillr committed Oct 4, 2012
Showing with 16 additions and 0 deletions.
  1. +16 −0 CONTRIBUTING.md
View
16 CONTRIBUTING.md
@@ -0,0 +1,16 @@
+The usual contributing steps are:
+
+* Fork the [official repository](https://github.com/brunch/brunch).
+* Clone your fork: git clone git@github.com:<your-username>/brunch.git
+* Make sure tests are passing for you: npm install && npm test
+* Create a topic branch: git checkout -b topics/new-feature-name
+* Add tests and code for your changes.
+* Once you‘re done, make sure all tests still pass: npm install && npm test
+* Make sure your code conforms [coffee style guide](https://github.com/paulmillr/code-style-guides#coffeescript).
+* Commit and push to your fork.
+* Create an pull request from your branch.
+* Sit back and enjoy.
+
+If you want to create your own plugin, you can use
+[brunch-boilerplate-plugin](https://github.com/brunch/brunch-boilerplate-plugin)
+as a base.

0 comments on commit 6c54c4b

Please sign in to comment.
Something went wrong with that request. Please try again.