github.com/dhaiducek/policy-generator-plugin@v1.99.99/CONTRIBUTING.md (about) 1 **Table of Contents** 2 3 - [Contributing guidelines](#contributing-guidelines) 4 - [Terms](#terms) 5 - [Certificate of Origin](#certificate-of-origin) 6 - [DCO Sign Off](#dco-sign-off) 7 - [Code of Conduct](#code-of-conduct) 8 - [Contributing a patch](#contributing-a-patch) 9 - [Issue and pull request management](#issue-and-pull-request-management) 10 - [Pre-check before submitting a PR](#pre-check-before-submitting-a-pr) 11 12 # Contributing guidelines 13 14 ## Terms 15 16 All contributions to the repository must be submitted under the terms of the 17 [Apache Public License 2.0](https://www.apache.org/licenses/LICENSE-2.0). 18 19 ## Certificate of Origin 20 21 By contributing to this project, you agree to the Developer Certificate of 22 Origin (DCO). This document was created by the Linux Kernel community and is a 23 simple statement that you, as a contributor, have the legal right to make the 24 contribution. See the 25 [DCO](https://github.com/open-cluster-management-io/community/blob/main/DCO) file 26 for details. 27 28 ## DCO Sign Off 29 30 You must sign off your commit to state that you certify the 31 [DCO](https://github.com/open-cluster-management-io/community/blob/main/DCO). To 32 certify your commit for DCO, add a line like the following at the end of your 33 commit message: 34 35 ``` 36 Signed-off-by: John Smith <john@example.com> 37 ``` 38 39 This can be done with the `--signoff` option to `git commit`. See the 40 [Git documentation](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) 41 for details. 42 43 ## Code of Conduct 44 45 The Open Cluster Management project has adopted the CNCF Code of Conduct. Refer 46 to our 47 [Community Code of Conduct](https://github.com/open-cluster-management-io/community/blob/main/CODE_OF_CONDUCT.md) 48 for details. 49 50 ## Contributing a patch 51 52 1. Submit an issue describing your proposed change to the repository in 53 question. The repository owners will respond to your issue promptly. 54 2. Fork the desired repository, then develop and test your code changes. 55 3. Submit a pull request. 56 57 ## Issue and pull request management 58 59 Anyone can comment on issues and submit reviews for pull requests. In order to 60 be assigned an issue or pull request, you can leave a `/assign <your Github ID>` 61 comment on the issue or pull request (PR). 62 63 ## Pre-check before submitting a PR 64 65 Before submitting a PR, perform the following steps: 66 67 ```shell 68 make fmt 69 make lint 70 make test 71 ``` 72 73 If there are any updates to the YAML, also make sure to update the [policy-generator.yaml](./docs/policy-generator.yaml) file.