Contribute to k0smotron#
Thank you for your interest in k0smotron. We look forward to working with you to grow and enhance the product.
Report issue#
Before making your k0mostron contribution, open a GitHub issue in the k0smotron project to discuss your idea.
Subscribe to an issue to receive notifications and stay up to date.
Code of conduct#
k0smotron follows the CNCF Code of Conduct.
Coding guidelines#
k0smotron follows the Effective Go coding guidelines.
Development environment#
Ensure successful development by setting up your environment correctly. For basic k0smotron development, install Go, and follow k0smotron GitHub workflow. For tasks involving CAPI testing, follow k0smotron instructions on setting up the CAPI development environment.
Follow k0smotron GitHub workflow#
Ensure that your contribution adheres to the k0smotron GitHub workflow:
- Fork the project.
- Configure remote repository.
- Prepare feature branch.
- Test your change.
- Commit with a sign-off.
- Push your change.
- Open a pull request.
Test code#
All PRs submitted to the k0smotron project go through a series of tests and reviews. As such, you should run your own tests before you submit a PR, as this will reduce the number of review iterations and automated test runs. For detailed information, refer to the k0smotron testing guidelines.
License#
In contributing to the k0smotron project, you agree that your submissions will be licensed as follows:
- All content residing under the
docs
directory is licensed under "Creative Commons Attribution Share Alike 4.0 International" (CC-BY-SA-4.0). - Content outside the above-mentioned directories or restrictions above is available under the "Apache License 2.0".
Community#
Get the latest news on k0smotron from the k0sproject Twitter account. You can also learn about k0smotron updates and initiatives on the official k0s community blog. Share your views on the Lens Forums.