Contributions to this project are welcome. We request that you read through the guidelines before getting started.
## Contributor License Agreement
Your contribution is accepted under the Apache 2.0 license.
Get acquainted with our code of conduct that contains our community guidelines.
### Code quality
As a contributor, make sure that you follow the golang coding standards and conventions established in:
All submissions will be reviewed before merging. Submissions are reviewed using GitHub pull requests.
Please make sure before you submit a pull request that a corresponding Github issue exists where the problem you are trying to solve and any implementation approach can be discussed.
Also, remember to link your pull request to the corresponding issue.
Run the tests with:
$ go test ./...
User documentation for this project is inlined in the source files. Make sure that any piece of functionality that is added, deleted or modified by your contribution is reflected in the appropriate places:
- Overall package description:
doc.go - Usage examples:
example_test.go - Package methods, global variables & constants: the relevant source file