Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 960 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 960 Bytes

Contributing

Thanks for your interest in contributing to this o!

Getting Started

  • make sure you have a GitHub account
  • submit a ticket for your issue, assuming one does not already exist
    • clearly describe the issue including steps to reproduce when it is a bug
    • identify specific versions of the binaries and client libraries
  • fork the repository on GitHub

Making Changes

  • create a branch from where you want to base your work
  • make commits of logical units
  • make sure your commit messages are in a clear and readable format, example:
  • if you're fixing a bug or adding functionality it probably makes sense to write a test
  • run all tests and make sure all pass

Submitting Changes

  • push your changes to your branch in your fork of the repository
  • submit a pull request against this repository
  • comment in the pull request when you're ready for the changes to be reviewed: "ready for review"