From 19bf281872338b7b6f98ffefb52b1d60b1b9af33 Mon Sep 17 00:00:00 2001 From: Mike Burns Date: Fri, 22 Jul 2011 17:12:50 -0400 Subject: [PATCH] Add a document describing how to contribute. --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 43 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..31c4904 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +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! diff --git a/README.md b/README.md index 495f6a0..2dae59e 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,11 @@ More Information factory_girl: http://github.com/thoughtbot/factory_girl/tree/master +Contributing +------------ + +Please see CONTRIBUTING.md for details. + Credits -------