Add contributing file

paulelliott · Oct 12, 2012 · 58afc13 · 58afc13
1 parent a6ec06c
commit 58afc13
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,13 @@
+### Contributing
+
+I ([paulelliott](http://github.com/paulelliott)) am actively maintaining this
+project. If you would like to contribute, please fork the project, TDD your
+changes with rspec on a feature branch, and submit a pull request.
+
+To run rake successfully:
+
+1. Clone the project
+2. Install mongodb and sqlite3 (brew install ...)
+3. Install bundler (gem install bundler)
+4. Run `bundle` from the project root
+5. Run `rake` and the test suite should be all green!