CONTRIBUTING.md

Contribution Guide

Contributions encouraged

I'd love to hear from you! If you have a question, bug report, feature request or a pull request, please reach out.

How to reach out

The preferred way at the moment is to open issues on the Github Issue Tracker

If you want to contribute improvements, open a pull request.

How to open the perfect issue

• Be specific and as detailed as you feel is necessary to understand the topic
• Provide context (what were you trying to achive, what were you expecting, ...)
• Code samples and logs can be really helpful. Consider Gists or links to other Github repos for larger pieces.
• If you are reporting a bug, add steps to reproduce it.

How to create the perfect pull request

• Have a look into the README for details on how to work with the code
• Follow the usual best practices for pull requests:
  • use a branch,
  • make sure you have pulled changes from upstream so that your change is easy to merge
  • follow the conventions in the code
  • keep a tidy commit history that speaks for itself, consider squashing commits where appropriate
• Run all the tests: ./go test
• Add tests where possible. If you are adding a new feature, consider adding it to the integration_spec which also serves as a usage example. If the new feature needs infrastructure to run, add it to example_infra