How to contribute:
Bug reports / Issues¶ ↑
-
Is something broken or not working as expected? Check for an existing issue or create a new one
-
IMPORTANT: Include the output of
metric_fu --debug-info
Code¶ ↑
-
Fork and clone the repo:
git clone git://github.com/yourghname/metric_fu.git && cd metric_fu
-
Install the gem dependencies:
bundle install
-
Make the changes you want and back them up with tests.
-
Run the tests (
bundle exec rspec
) -
Run metric_fu on itself (
bundle exec ruby -Ilib bin/metric_fu
) -
Update the HISTORY.md file with your changes and give yourself credit
-
Commit and create a pull request with details as to what has been changed and why
-
Use well-described, small (atomic) commits.
-
Include links to any relevant github issues.
-
Don't change the VERSION file.
-
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¶ ↑
About Pull Requests (PR's)¶ ↑
Documentation¶ ↑
-
If relevant, you may update the metric_fu website in a separate pull request to that repo
-
Update the wiki