Contributing to Mail
Hi there, I welcome pull requests! Here are some thoughts on how to get your pull request merged quickly:
- Check the Reference RFCs, they are in the References directory, so no excuses.
- Check for a ticket on GitHub, maybe someone else has the problem too
- Make a fork of my GitHub repository
- Run the specs. We only take pull requests with passing tests, and it's great
to know that you have a clean slate:
bundle && bundle exec rake
- Add a spec for your change. Only refactoring and documentation changes require no new specs. If you are adding functionality or fixing a bug, we need a spec!
- Test the spec at least against MRI-1.9.3 and MRI-1.8.7
- Update the README if needed to reflect your change / addition
- Update the CHANGELOG and give yourself credit
- With all specs passing push your changes back to your fork
- Send me a pull request.
- If it needs any changes, please push or force push to the same branch you made the pull request from. GitHub will just update the pull request with your changes.
Note, specs that break MRI 1.8.7 or 1.9.3 will not be accepted.
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:
- Tell me you have tested it against more than one version of Ruby, RVM is great for this. I test against 7 rubies before I push into master.
- Use good, idiomatic, structured and modular code
- 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
- 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 specs!
Testing against mime-types versions:
Use appraisal to run against all supported versions of mime-types.
(bundle check || bundle) && appraisalso that all the 'appraised' gemfiles are bundled.
- Run either
rake appraisalto run all the tests.
To run only one 'appraised' gemfile, run. e.g.
BUNDLE_GEMFILE=gemfiles/mime_types_edge.gemfile (bundle check || bundle) && rake
To change the appraisals, modify the
Appraisals file, run
appraisal, commit the generated gemfiles, and modify the .travis.yml matrix.
To run on all rubies / gemfiles, just like TravisCI, see WWTD.