Permalink
Browse files

Add Appraisal install line to CONTRIBUTING.md

* Setting up Appraisal is necessary to run the test suite.
  • Loading branch information...
1 parent 6ad1068 commit 21c330840c3ff5cd733bd5a031e8456ddb4bcd55 @croaky croaky committed Jul 21, 2012
Showing with 11 additions and 19 deletions.
  1. +1 −0 .gitignore
  2. +10 −19 CONTRIBUTING.md
View
1 .gitignore
@@ -8,3 +8,4 @@ db/*.sqlite3
log/*.log
pkg
tmp/
+bin/
View
29 CONTRIBUTING.md
@@ -2,17 +2,19 @@ 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 db:migrate && 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!
+2. Set up Appraisal, which helps us test against multiple Rails versions:
+ `rake appraisal:install`.
-4. Make the test pass.
+3. Run the tests. We only take pull requests with passing tests, and it's great
+ to know that you have a clean slate: `rake`
-5. Push to your fork and submit a pull request.
+4. 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!
+5. Make the test pass.
+
+6. 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
@@ -25,14 +27,3 @@ taken straight from the Ruby on Rails guide:
* 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!

0 comments on commit 21c3308

Please sign in to comment.