Issues, whether bugs, tasks, or feature requests are essential for improving this project. We believe it should be as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can keep on top of things.
This project adheres to a code of conduct. Please review this document before contributing to this project.
Before you can contribute, you will need to sign the Contributor License Agreement.
The cmd folder contains logic specific to interacting with the command line. As much reusable functionality as possible should be placed in the pkg folder.
We label issues with the "good first issue" tag if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up. Another good place to start would be adding regression tests to existing plugins.
- A properly configured Golang environment with Go 1.13 or higher
go test ./pkg/...
If you've encountered an issue that is not already reported, please create a new issue, choose Bug Report, Feature Request or Misc. and follow the instructions in the template.
Each new pull request should:
- Reference any related issues
- Pass existing tests and linting
- Contain a clear indication of if they're ready for review or a work in progress
- Be up to date and/or rebased on the master branch
- Update the
CHANGELOG.mdwith any changes - Create a new tag with the latest version number