Skip to content
This repository
Browse code

Update contribution guidelines.

commit bd5220abb898c6e1bab94c9c16a0546dc5c04a3c 1 parent e5c5efd
Gabe Berke-Williams authored March 18, 2012

Showing 1 changed file with 38 additions and 0 deletions. Show diff stats Hide diff stats

  1. 38  CONTRIBUTING.md
38  CONTRIBUTING.md
Source Rendered
... ...
@@ -0,0 +1,38 @@
  1
+We love pull requests. Here's a quick guide:
  2
+
  3
+1. Fork the repo.
  4
+
  5
+2. Run the tests. We only take pull requests with passing tests, and it's great
  6
+to know that you have a clean slate: `bundle && rake`
  7
+
  8
+3. Add a test for your change. Only refactoring and documentation changes
  9
+require no new tests. If you are adding functionality or fixing a bug, we need
  10
+a test!
  11
+
  12
+4. Make the test pass.
  13
+
  14
+5. Push to your fork and submit a pull request.
  15
+
  16
+
  17
+At this point you're waiting on us. We like to at least comment on, if not
  18
+accept, pull requests within three business days (and, typically, one business
  19
+day). We may suggest some changes or improvements or alternatives.
  20
+
  21
+Some things that will increase the chance that your pull request is accepted,
  22
+taken straight from the Ruby on Rails guide:
  23
+
  24
+* Use Rails idioms and helpers
  25
+* Include tests that fail without your code, and pass with it
  26
+* Update the documentation, the surrounding one, examples elsewhere, guides,
  27
+  whatever is affected by your contribution
  28
+
  29
+Syntax:
  30
+
  31
+* Two spaces, no tabs.
  32
+* No trailing whitespace. Blank lines should not have any space.
  33
+* Prefer &&/|| over and/or.
  34
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
  35
+* a = b and not a=b.
  36
+* Follow the conventions you see used in the source already.
  37
+
  38
+And in case we didn't emphasize it enough: we love tests!

0 notes on commit bd5220a

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