Skip to content
This repository has been archived by the owner on Mar 20, 2019. It is now read-only.

Latest commit

 

History

History
34 lines (23 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.31 KB
Raw

Contributing

This project is MIT licensed and welcomes outside contributions.

Reporting issues

Report issues using the Github issues tracker.

When reporting issues, please incldue the following information:

  • Your Ruby interpreter version.
  • The statsd-instrument version. Note: only the latest version is supported.
  • The StatsD backend you are using.

Pull request

  1. Fork the repository, and create a branch.
  2. Implement the feature or bugfix, and add tests that cover the changed functionality.
  3. Create a pull request. Make sure that you get Travis CI passes.
  4. Ping @jstorimer and/or @wvanbergen for a code review.

Some notes:

  • Make sure to follow to coding style.
  • Make sure your changes are properly documented using yardoc syntax.
  • Add an entry to the "unreleased changes" section of CHANGELOG.md.
  • Do not update StatsD::Instrument::VERSION. This will be done during the release prodecure.

Release procedure

  1. Update the version number in lib/statsd/instrument/version.rb.
  2. Move the "Unreleased changes" items in CHANGELOG.md to a new section for the release.
  3. Commit these changes.
  4. Run bundle exec rake release.