From 575f3627fc8001a33a5bfd1ba9aaa402e9d2050e Mon Sep 17 00:00:00 2001 From: Anita-ihuman <62384659+Anita-ihuman@users.noreply.github.com> Date: Thu, 30 Sep 2021 04:52:03 +0100 Subject: [PATCH] Updating the Contributing.md file (#2450) * create configuration for behaviour bot Signed-off-by: Anita-ihuman * adding contributor images Signed-off-by: Anita-ihuman * fixed typo in config.yml Signed-off-by: Anita-ihuman * including config file to ignore. Signed-off-by: Anita-ihuman * refined the contributing.md file Signed-off-by: Anita-ihuman * updated the contributing.md file Signed-off-by: Anita-ihuman * updated the contributing.md file Signed-off-by: Anita-ihuman * updated the contributing.md file Signed-off-by: Anita-ihuman --- CONTRIBUTING.md | 74 ++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 64 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ba0c8b6f5..06faba4a73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,20 +2,74 @@ We welcome all contributions, suggestions, and feedback, so please do not hesitate to reach out! -The easiest way to reach us is on the [Kubernetes slack #kyverno channel](https://app.slack.com/client/T09NY5SBT/CLGR9BJU9). -## Ways you can contribute -- Report potential bugs -- Request a feature -- Request a sample policy -- Join our community meetings -- Submit a PR for [open issues](https://github.com/kyverno/kyverno/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) -- Fix or improve documentation +## Ways you can contribute: + - [Report Issues](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#report-issues) + - [Submit Pull Requests](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#submit-pull-requests) + - [Fix or Improve Documentation](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#fix-or-improve-documentation) + - [Join Our Community Meetings](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#join-our-community-meetings) + +### Report issues + - Report potential bugs + - Request a feature + - Request a sample policy + +### Submit Pull Requests +#### Setup local development environments +- Please refer to [Running in development mode](https://github.com/kyverno/kyverno/wiki/Running-in-development-mode) for local setup. + +#### Submit a PR for [open issues](https://github.com/kyverno/kyverno/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +### Fix or Improve Documentation + - [Kyverno Docs](https://github.com/kyverno/website) + #### Get started + +Head over to 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:** + +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 +``` + + - **Create a branch:** + + Create a new brach and navigate to the branch using this command. + + ``` + $ git checkout -b + ``` + + Great, its time to start hacking, You can now go ahead to make all the changes you want. + + + - **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 the commit. + + Go ahead and push your changes to github using this command. + + ``` + $ git push + ``` + + -The [Kyverno Wiki](https://github.com/kyverno/kyverno/wiki) contains details on code design, building, and testing. Please review all sections. Before you contribute, please review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md). - +### Join Our Community Meetings + The easiest way to reach us is on the [Kubernetes slack #kyverno channel](https://app.slack.com/client/T09NY5SBT/CLGR9BJU9). ## 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.