I love pull requests. Here's a quick guide:
- Fork the repo.
- Run the tests. I only take pull requests with passing tests, and it's great
to know that you have a clean slate:
bundle && rake
- Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, I need a test!
- Make the test pass.
- Make sure your changes adhere to the thoughtbot Style Guide
- Write an [awesome] [commit] [message]. [awesome]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html [commit]: http://robots.thoughtbot.com/post/48933156625/5-useful-tips-for-a-better-commit-message [message]: http://rakeroutes.com/blog/deliberate-git/
- Push to your fork and submit a pull request.
- At this point you're waiting on us. I like to at least comment on, if not accept, pull requests within a few days (and, typically, one business day). I 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
&&
/||
overand
/or
. MyClass.my_method(my_arg)
notmy_method( my_arg )
ormy_method my_arg
.a = b
and nota=b
.- Follow the conventions you see used in the source already.
- And in case I didn't emphasize it enough: I love tests!