Contributing - mime-types-1.25.1 Documentation

## Contributing¶ ↑

I value any contribution to MIME::Types you can provide: a bug report, a feature request, or code contributions.

Code contributions to MIME::Types are especially <del>welcome</del>encouraged. Because MIME::Types is a complex codebase, there are a few guidelines:

- Changes (aside from new MIME types) <strong>will not</strong> be accepted without tests. The test suite is written with MiniTest.

- Match my coding style.

- Use a thoughtfully-named topic branch that contains your change. Rebase your commits into logical chunks as necessary.

- Use quality commit messages.

- Do not change the version number; when your patch is accepted and a release is made, the version will be updated at that point.

- Submit a GitHub pull request with your changes.

- New features require new documentation.

### Test Dependencies¶ ↑

To run the test suite, you will need to install the development dependencies for MIME::Types. If you have Bundler, you can accomplish this easily:

    $ bundle install

MIME::Types uses Ryan Davis’s excellent Hoe to manage the release process, and it adds a number of rake tasks. You will mostly be interested in:

    $ rake

which runs the tests the same way that:

    $ rake test
    $ rake travis

will do.

### Workflow¶ ↑

Here's the most direct way to get your work merged into the project:

- Fork the project.

- Clone down your fork (+git clone git://github.com/<username>/mime-types.git+).

- Create a topic branch to contain your change (+git checkout -b my_awesome_feature+).

- Hack away, add tests. Not necessarily in that order.

- Make sure everything still passes by running `rake`.

- If necessary, rebase your commits into logical chunks, without errors.

- Push the branch up (+git push origin my_awesome_feature+).

- Create a pull request against halostatue/mime-types and describe what your change does and the why you think it should be merged.

### Contributors¶ ↑

- Austin Ziegler created MIME::Types.

Thanks to everyone else who has contributed to MIME::Types:

- Andre Pankratz

- Mauricio Linhares

- Richard Hirner

- Todd Carrico

- Garret Alfert

- Hans de Graaff

- Henrik Hodne

- Martin d'Allens

- cgat

- Greg Brockman