Skip to content

Latest commit

 

History

History
136 lines (86 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

136 lines (86 loc) · 6.42 KB
Raw

Contributing Guidelines for Kyverno

We welcome all contributions, suggestions, and feedback, so please do not hesitate to reach out!

Before you contribute, please take a moment to review and agree to abide by our community Code of Conduct.

Engage with us

The Kyverno website has the most updated information on how to engage with the Kyverno community including its maintainers and contributors. There are three classes of contributors possible: Contributor, Code Owner, and Maintainer. Please see the Contributing section on the website for the requirements and privileges afforded to each.

Join our community meetings to learn more about Kyverno and engage with other contributors.

Ways you can contribute

1. Report issues

Issues to Kyverno help improve the project in multiple ways including the following:

  • Report potential bugs
  • Request a feature
  • Request a sample policy

2. Fix or Improve Documentation

The Kyverno website, like the main Kyverno codebase, is stored in its own git repo. To get started with contributions to the documentation, follow the guide on that repository.

3. Submit Pull Requests

Pull requests (PRs) allow you to contribute back the changes you've made on your side enabling others in the community to benefit from your hard work. They are the main source by which all changes are made to this project and are a standard piece of GitHub operational flows.

New contributors may easily view all open issues labeled as good first issues allowing you to get started in an approachable manner.

Once you wish to get started contributing to the code base, please refer to our running in development mode for local setup guide.

In the process of submitting your PRs, please read and abide by the template provided to ensure the maintainers are able to understand your changes and quickly come up to speed. There are some important pieces that are required outside the code itself. Some of these are up to you, others are up to the maintainers.

  1. Provide Proof Manifests allowing the maintainers and other contributors to verify your changes without requiring they understand the nuances of all your code.
  2. For new or changed functionality, this typically requires documentation and so raise a corresponding issue (or, better yet, raise a separate PR) on the documentation repository.
  3. Test your change with the Kyverno CLI and provide a test manifest in the proper format. If your feature/fix does not work with the CLI, a separate issue requesting CLI support must be made. For changes which can be tested as an end user, we require conformance/e2e tests by using the kuttl tool. See here for a specific guide on how and when to write these tests.
  4. Indicate which release this PR is triaged for (maintainers). This step is important especially for the documentation maintainers in order to understand when and where the necessary changes should be made.

How to Create a PR

Head over to the project repository on GitHub and click the "Fork" button. With the forked copy, you can try new ideas and implement changes to the project.

  1. Clone the repository to your device:

Get the link of your forked repository, paste it in your device terminal and clone it using the command.

git clone https://hostname/YOUR-USERNAME/YOUR-REPOSITORY
  1. Create a branch:

Create a new brach and navigate to the branch using this command.

git checkout -b <new-branch>

Great, it's time to start hacking! You can now go ahead to make all the changes you want.

  1. Stage, Commit, and Push changes:

Now that we have implemented the required changes, use the command below to stage the changes and commit them.

git add .
git commit -s -m "Commit message"

The -s signifies that you have signed off the commit.

Go ahead and push your changes to GitHub using this command.

git push

Cherry-pick PRs to release branches

Once you fork the project, you will notice that there are a number of branches related to Kyverno's releases such as release-1.7. You can view the list of remote branches by using the command below:

$ git branch -r
...
origin/release-1.5
origin/release-1.6
origin/release-1.7

Checkout one of the release branch and cherry-pick the PRs you want to merge into the release branch:

$ git checkout release-1.7

git cherry-pick <commit-hash> -s

git push --set-upstream origin release-1.7

Once the commit has been cherry-picked, the author will need to open a PR merging to the release branch, release-1.7 for example.

Developer Certificate of Origin (DCO) Sign off

For contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project, we are requiring everyone to acknowledge this by signing their work which indicates you agree to the DCO found here.

To sign your work, just add a line like this at the end of your commit message:

Signed-off-by: Random J Developer <random@developer.example.org>

This can easily be done with the -s command line option to append this automatically to your commit message.

git commit -s -m 'This is my commit message'

Release Processes

Review the Kyverno release process at: https://kyverno.io/docs/releases/