How to contribute:

Bug reports / Issues

Code

  1. Fork and clone the repo: git clone git://github.com/yourghname/metric_fu.git && cd metric_fu

  2. Install the gem dependencies: bundle install

  3. Make the changes you want and back them up with tests.

  4. Run the tests (bundle exec rspec)

  5. Run metric_fu on itself (bundle exec ruby -Ilib bin/metric_fu)

  6. Update the HISTORY.md file with your changes and give yourself credit

  7. Commit and create a pull request with details as to what has been changed and why

  8. Use well-described, small (atomic) commits.

  9. Include links to any relevant github issues.

  10. Don't change the VERSION file.

  11. Extra Credit: Confirm it runs and tests pass on the rubies specified in the travis config. I will otherwise confirm it runs on these.

How I handle pull requests:

Commit Messages

About Pull Requests (PR's)

Documentation