Skip to content
This repository
Browse code

Add a document describing how to contribute.

  • Loading branch information...
commit 19bf281872338b7b6f98ffefb52b1d60b1b9af33 1 parent d982e6f
Mike Burns mike-burns authored

Showing 2 changed files with 43 additions and 0 deletions. Show diff stats Hide diff stats

  1. +38 0 CONTRIBUTING.md
  2. +5 0 README.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!
5 README.md
Source Rendered
@@ -35,6 +35,11 @@ More Information
35 35
36 36 factory_girl: http://github.com/thoughtbot/factory_girl/tree/master
37 37
  38 +Contributing
  39 +------------
  40 +
  41 +Please see CONTRIBUTING.md for details.
  42 +
38 43 Credits
39 44 -------
40 45

0 comments on commit 19bf281

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