Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 1.13 KB

Sidekiq-InfluxDB

Reference documentation

Contributing Guidelines

  1. We welcome addition of useful Sidekiq metrics and optimisations of the existing ones.
  2. All code should be covered by tests. This library is used in high load Sidekiq deployments. Failures are unacceptable.
  3. Code should be easy for an average Rubyist to understand.
  4. Each pull request should contain changes for a single goal.
  5. All logic should be described in the README for users of the library in the most understandable and ready-to-use way.
  6. This library uses an existing InfluxDB client object supplied by the user. It does not modify the client in any way.
  7. It is better to write a little too many metrics than a little too few. It is good to let the user disable stuff they don't need.
  8. It should work in as many Ruby versions as possible. People run a lot of old versions in production. Same for Sidekiq and InfluxDB.
  9. RuboCop is not necessary and is not welcome in this project.

Thank you for your contributions!