mirror of
https://github.com/kyverno/kyverno.git
synced 2024-12-15 17:51:20 +00:00
32 lines
2.5 KiB
Markdown
32 lines
2.5 KiB
Markdown
# Contributor Guidelines for Kyverno
|
|
|
|
[Kyverno and its sub-projects](https://github.com/kyverno#projects) follow the contributor guidelines published at: https://github.com/kyverno/community/blob/main/CODE_OF_CONDUCT.md.
|
|
|
|
Please review the general guidelines before proceeding further to the project specific information below.
|
|
|
|
### Fix or Improve Kyverno Documentation
|
|
|
|
The [Kyverno website](https://kyverno.io), like the main Kyverno codebase, is stored in its own [git repo](https://github.com/kyverno/website). To get started with contributions to the documentation, [follow the guide](https://github.com/kyverno/website#contributing) on that repository.
|
|
|
|
### Developer Guides
|
|
|
|
To learn about the code base and developer processes, refer to the [development guide](/DEVELOPMENT.md).
|
|
|
|
### Good First Issues
|
|
|
|
Maintainers identify issues that are ideal for new contributors with a `good first issue` label.
|
|
|
|
View all Kyverno [good first issues](https://github.com/kyverno/kyverno/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
|
|
|
### Pull Request Guidelines
|
|
|
|
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](https://github.com/kyverno/website).
|
|
3. Test your change with the [Kyverno CLI](https://kyverno.io/docs/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 `chainsaw` tool. See [here](https://github.com/kyverno/kyverno/tree/main/test/conformance/chainsaw/README.md) 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.
|
|
|
|
## Release Processes
|
|
|
|
Review the Kyverno release process at: https://kyverno.io/docs/releases/
|