Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

a contributing guide

  • Loading branch information...
commit 3e9527a41dd313b4edb176d0d9b71605ee4b39e8 1 parent 01665e6
@mike-burns mike-burns authored
Showing with 46 additions and 0 deletions.
  1. +41 −0 CONTRIBUTING.md
  2. +5 −0 README.md
View
41 CONTRIBUTING.md
@@ -0,0 +1,41 @@
+We love pull requests. Here's a quick guide:
+
+1) Fork the repo.
+
+2) Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate:
+
+ bundle
+ rake
+
+3) Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4) Make the test pass.
+
+5) Push to your fork and submit a pull request.
+
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+ whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!
View
5 README.md
@@ -44,6 +44,11 @@ Set your Capybara Javascript driver to webkit:
Tag scenarios with @javascript to run them using a headless WebKit browser.
+Contributing
+------------
+
+See the CONTRIBUTING document.
+
About
-----
Please sign in to comment.
Something went wrong with that request. Please try again.