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

improved the contributing guidelines. (#2766)

Browse source 
Signed-off-by: Anita-ihuman <charlesanita403@gmail.com>
This commit is contained in:
Anita-ihuman 2021-11-30 14:18:39 +01:00 committed by GitHub
parent 4c251bcffd
commit 5ef89e7da0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
CONTRIBUTING.md
View file

@ -1,13 +1,19 @@
# Contributing to Kyverno
# Contributing Guidelines for Kyverno
We welcome all contributions, suggestions, and feedback, so please do not hesitate to reach out!
## Ways you can contribute
Before you contribute, please take a moment to review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md).
- [Report Issues](#report-issues)
- [Submit Pull Requests](#submit-pull-requests)
- [Fix or Improve Documentation](#fix-or-improve-documentation)
- [Join Our Community Meetings](#join-our-community-meetings)
- [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)
- [Developer Certificate of Origin (DCO) Sign off](#developer-certificate-of-origin-dco-sign-off)
## Ways you can contribute
### Report issues
@ -17,9 +23,13 @@ Issues to Kyverno help improve the project in multiple ways including the follow
- Request a feature
- Request a sample policy
### 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.
### 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. Before you contribute, please take a moment to review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md).
[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.
New contributors may easily view all [open issues labeled as good first issues](https://github.com/kyverno/kyverno/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) allowing you to get started in an approachable manner.
@ -32,11 +42,11 @@ 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.
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.
#### Getting started with your 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.
**Clone the repository to your device:**
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.
@ -44,7 +54,7 @@ Get the link of your forked repository, paste it in your device terminal and clo
git clone https://hostname/YOUR-USERNAME/YOUR-REPOSITORY
```
**Create a branch:**
2. **Create a branch:**
Create a new brach and navigate to the branch using this command.
@ -54,7 +64,7 @@ git checkout -b <new-branch>
Great, it's time to start hacking! You can now go ahead to make all the changes you want.
**Stage, Commit, and Push changes:**
3. **Stage, Commit, and Push changes:**
Now that we have implemented the required changes, use the command below to stage the changes and commit them.
@ -71,14 +81,10 @@ The `-s` signifies that you have signed off the the commit.
Go ahead and push your changes to GitHub using this command.
```sh
git push
git push
```
### 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.
### Engage with us
## Engage with us
The website has the most updated information on [how to engage with the Kyverno community](https://kyverno.io/community/) including its maintainers and contributors.

13
MAINTAINERS.md Normal file
View file

@ -0,0 +1,13 @@
## Maintainer
They are approvers who have shown good technical judgement in feature design/development in the past. Has overall knowledge of the project and features in the project. These role is for project managers who are expected to manage the repository without access to sensitive or destructive actions.
| Maintainer | GitHub ID | Affiliation |
| ----------- | ------------------------------------------- | ------------------------- |
| JimBugwadia | [github-id](https://github.com/JimBugwadia) | Nirmata Inc. |
| Realshuting | [github-id](https://github.com/realshuting) | Nirmata Inc. |
| Chip zoller | [github-id](https://github.com/chipzoller) | dell |
| Marcel Mue | [github-id](https://github.com/MarcelMue) | Giant Swarm GmbH |
| Treydock | [github-id](https://github.com/treydock) | Ohio Supercomputer Center |
**Note**: Please refer to the [Project Governance](https://kyverno.io/community/project-governance/) for more information on the responsibilities and privileges of a maintainer in Kyverno.