mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-14 11:57:48 +00:00
Code Activity

update contributing guide (#4119)

Browse source 
Signed-off-by: Jim Bugwadia <jim@nirmata.com>
This commit is contained in:
Jim Bugwadia 2022-06-19 23:13:39 -07:00 committed by GitHub
parent 008b9ab48e
commit f67f145d90
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
CONTRIBUTING.md
View file

@ -5,17 +5,24 @@ We welcome all contributions, suggestions, and feedback, so please do not hesita
Before you contribute, please take a moment to review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md). Before you contribute, please take a moment to review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md).
- [Contributing Guidelines for Kyverno](#contributing-guidelines-for-kyverno) - [Contributing Guidelines for Kyverno](#contributing-guidelines-for-kyverno)
- [Ways you can contribute](#ways-you-can-contribute)
- [Report issues](#report-issues)
- [Fix or Improve Documentation](#fix-or-improve-documentation)
- [Submit Pull Requests](#submit-pull-requests)
- [How to Create a PR](#how-to-create-a-pr)
- [Engage with us](#engage-with-us) - [Engage with us](#engage-with-us)
- [Developer Certificate of Origin (DCO) Sign off](#developer-certificate-of-origin-dco-sign-off) - [Ways you can contribute](#ways-you-can-contribute)
- [1. Report issues](#1-report-issues)
- [2. Fix or Improve Documentation](#2-fix-or-improve-documentation)
- [3. Submit Pull Requests](#3-submit-pull-requests)
- [How to Create a PR](#how-to-create-a-pr)
- [Developer Certificate of Origin (DCO) Sign off](#developer-certificate-of-origin-dco-sign-off)
- [Release Processes](#release-processes)
## Engage with us
The Kyverno website has the most updated information on [how to engage with the Kyverno community](https://kyverno.io/community/) including its maintainers and contributors.
Join our community meetings to learn more about Kyverno and engage with other contributors.
## Ways you can contribute ## Ways you can contribute
### Report issues ### 1. Report issues
Issues to Kyverno help improve the project in multiple ways including the following: Issues to Kyverno help improve the project in multiple ways including the following:
@ -23,11 +30,11 @@ Issues to Kyverno help improve the project in multiple ways including the follow
- Request a feature - Request a feature
- Request a sample policy - Request a sample policy
### Fix or Improve Documentation ### 2. Fix or Improve 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. 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.
### Submit Pull Requests ### 3. Submit Pull Requests
[Pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-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. [Pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-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.
@ -42,7 +49,7 @@ In the process of submitting your PRs, please read and abide by the template pro
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. 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.
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. 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 #### 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. 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.
@ -84,11 +91,7 @@ Go ahead and push your changes to GitHub using this command.
git push git push
``` ```
## Engage with us #### Developer Certificate of Origin (DCO) Sign off
The website has the most updated information on [how to engage with the Kyverno community](https://kyverno.io/community/) including its maintainers and contributors.
## 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](https://developercertificate.org/). 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](https://developercertificate.org/).
@ -103,3 +106,7 @@ This can easily be done with the `-s` command line option to append this automat
```sh ```sh
git commit -s -m 'This is my commit message' git commit -s -m 'This is my commit message'
``` ```
## Release Processes
Review the Kyverno release process at: https://kyverno.io/docs/releases/