Add contributing guidelines

kossnocorp · Nov 30, 2012 · 3737e44 · 3737e44
1 parent d9a787d
commit 3737e44
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# How to contribute
+
+## Run tests
+
+``` sh
+# Bundle gems
+bundle
+
+# Install npm packages
+npm install
+
+# Run tests 
+rake test
+
+# ... or run auto tests
+bundle exec guard
+```
+
+## Sending pull-request
+
+1. Fork
+2. Run the tests
+3. Add test for your change
+4. Make tests green
+5. Push
+6. Send pull-request
+
+## Please do not
+
+* Driving drunk
+* Hide the fact of finding Bigfoot
+* Mess with versions, gemspec file, package.json etc