Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 45 lines (36 sloc) 1.994 kb
7156bd3 @mikel Updating README and CONTRIBUTING
authored
1 Contributing to Mail
2 ====================
3
4 Hi there, I welcome pull requests! Here are some thoughts on how to get your
5 pull request merged quickly:
6
7 1. Check the Reference RFCs, they are in the References directory, so no excuses.
8 2. Check for a ticket on GitHub, maybe someone else has the problem too
9 3. Make a fork of my GitHub repository
10 4. Run the specs. We only take pull requests with passing tests, and it's great
11 to know that you have a clean slate: `bundle && bundle exec rake`
12 5. Add a spec for your change. Only refactoring and documentation changes
13 require no new specs. If you are adding functionality or fixing a bug, we need
14 a spec!
15 6. Test the spec _at_ _least_ against MRI-1.9.2 and MRI-1.8.7
16 7. Update the README if needed to reflect your change / addition
17 8. With all specs passing push your changes back to your fork
18 9. Send me a pull request
19
20 Note, specs that break MRI 1.8.7 will not be accepted.
21
22 At this point you're waiting on us. We like to at least comment on, if not
23 accept, pull requests within three business days (and, typically, one business
24 day). We may suggest some changes or improvements or alternatives.
25
26 Some things that will increase the chance that your pull request is accepted,
27 taken straight from the Ruby on Rails guide:
28
29 * Tell me you have tested it against more than one version of Ruby, RVM is great for
30 this. I test against 7 rubies before I push into master.
31 * Use good, idiomatic, strcutred and modular code
32 * Include tests that fail without your code, and pass with it
33 * Update the documentation, the surrounding one, examples elsewhere, guides,
34 whatever is affected by your contribution
35
36 Syntax:
37
38 * Two spaces, no tabs.
39 * No trailing whitespace. Blank lines should not have any space.
40 * Prefer &&/|| over and/or.
41 * MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
42 * a = b and not a=b.
43 * Follow the conventions you see used in the source already.
44
45 And in case we didn't emphasize it enough: we love specs!
Something went wrong with that request. Please try again.