How to contribute:

Bug reports / Issues¶ ↑

• Is something broken or not working as expected? Check for an existing issue or create a new one

• See Quick guide to writing good bug reports

• IMPORTANT: Include the output of metric_fu --debug-info

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:

• If the tests pass and the pull request looks good, I will merge it.

• If the pull request needs to be changed,

• you can change it by updating the branch you generated the pull request from

  • either by adding more commits, or

  • by force pushing to it

• I can make any changes myself and manually merge the code in.

Commit Messages¶ ↑

• A Note About Git Commit Messages

• stopwritingramblingcommitmessages.com/

• ThoughtBot style guide

About Pull Requests (PR's)¶ ↑

• All Your Open Source Code Are Belong To Us

• Using Pull Requests

• Github pull requests made easy

Documentation¶ ↑

• If relevant, you may update the metric_fu website in a separate pull request to that repo

• Update the wiki