Thank you for your interest in this project. If you wish to submit a bug report, propose a feature or contribute a change, please follow the guidelines described in this document.
We use the Github issue tracker for bugs and feature proposals. Please check both the open and closed lists before posting a new issue. Please be as specific as you can: issues should have descriptive titles and relevant labels.
Bug reports must contain:
- the expected behaviour
- why this behaviour is expected
- the actual behaviour
- detailed steps allowing to reproduce the problem
- the used package version
Before you start working on an open issue, add a comment telling that you're going to tackle it.
If it's your first contribution, start by forking the repository.
Do not forget to:
- add new test cases whenever they are needed
- run unit tests before asking for review
- add an entry in the CHANGELOG file
Commit messages should follow these guidelines:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
When your changes are ready for review, open a pull request and reference the corresponding issue.
Go source files must be formatted using the goimports tool.