Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 2.78 KB

Contributing.md

File metadata and controls

94 lines (71 loc) · 2.78 KB
Raw

Contributing

I value any contribution to minitar you can provide: a bug report, a feature request, or code contributions. There are a few guidelines for contributing to minitar:

  • Code changes will not 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 or changed behaviours require appropriate documentation.

Test Dependencies

minitar uses Ryan Davis’s 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.

To assist with the installation of the development dependencies for minitar, I have provided the simplest possible Gemfile pointing to the (generated) minitar.gemspec file. This will permit you to do:

$ bundle install

to get the development dependencies. If you aleady have hoe installed, you can accomplish the same thing with:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the RDoc.

You can run tests with code coverage analysis by running:

$ rake test:coverage

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>/minitar.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/minitar and describe what your change does and the why you think it should be merged.

Contributors

  • Austin Ziegler created minitar, based on work originally written by Mauricio Fernández for rpa-base.

Thanks to everyone who has contributed to minitar:

  • Akinori MUSHA (knu)
  • Antoine Toulme
  • Curtis Sampson
  • Daniel J. Berger
  • dearblue
  • inkstak
  • John Prince
  • Jorie Tappa
  • Kazuyoshi Kato
  • Kevin McDermott
  • Matthew Kent
  • Merten Falk
  • Michal Suchanek
  • Mike Furr
  • ooooooo_q
  • Pete Fritchman
  • Vijay (bv-vijay)
  • Yamamoto Kōhei
  • Zach Dennis