We welcome contributions to this project in the form of issues and pull requests.
Issues are a quick way to point out a bug. If you find a bug or documentation error in Unleash, this is the place to start.
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test are passing by running
make all test. - Create that pull request!
All code should be tested. Controller code should be tested with envtest and Ginkgo. All other code is tested with testify.
You can read more about writing Ginko tests here as well as writing kubebuilder envtests here.
We follow go best practices and the Effective Go style guide. We also use golangci-lint to enforce style and best practices.
By contributing to this project, you agree that your contributions will be licensed under the terms of the MIT License.