|
1 |
| -**Table of Contents** |
| 1 | +# Contributing Guide |
2 | 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 [Apache Public License 2.0](https://www.apache.org/licenses/LICENSE-2.0). |
17 |
| - |
18 |
| -## Certificate of Origin |
19 |
| - |
20 |
| -By contributing to this project, you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the [DCO](https://github.com/open-cluster-management/community/blob/main/DCO) file for details. |
21 |
| - |
22 |
| -## DCO Sign Off |
23 |
| - |
24 |
| -You must sign off your commit to state that you certify the [DCO](https://github.com/open-cluster-management/community/blob/main/DCO). To certify your commit for DCO, add a line like the following at the end of your commit message: |
25 |
| - |
26 |
| -``` |
27 |
| -Signed-off-by: John Smith <[email protected]> |
28 |
| -``` |
29 |
| - |
30 |
| -This can be done with the `--signoff` option to `git commit`. See the [Git documentation](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) for details. |
31 |
| - |
32 |
| -## Code of Conduct |
33 |
| - |
34 |
| -The Open Cluster Management project has adopted the CNCF Code of Conduct. Refer to our [Community Code of Conduct](https://github.com/open-cluster-management/community/blob/main/CODE_OF_CONDUCT.md) for details. |
35 |
| - |
36 |
| -## Contributing a patch |
37 |
| - |
38 |
| -1. Submit an issue describing your proposed change to the repository in question. The repository owners will respond to your issue promptly. |
39 |
| -2. Fork the desired repository, then develop and test your code changes. |
40 |
| -3. Submit a pull request. |
41 |
| - |
42 |
| -## Issue and pull request management |
43 |
| - |
44 |
| -Anyone can comment on issues and submit reviews for pull requests. In order to be assigned an issue or pull request, you can leave a `/assign <your Github ID>` comment on the issue or pull request (PR). |
45 |
| - |
46 |
| -## Pre-check before submitting a PR |
47 |
| - |
48 |
| -Before submitting a PR, please perform the following steps: |
49 |
| - |
50 |
| -```shell |
51 |
| -make fmt |
52 |
| -make lint |
53 |
| -make test |
54 |
| -``` |
55 |
| - |
56 |
| -## Post-submit FOSSA License and Security Scan |
57 |
| - |
58 |
| -After the Pull Request is submitted, a [FOSSA](https://fossa.com/) scan is run through a GitHub |
59 |
| -action. The scan will verify that the code and its dependencies comply with open source licensing |
60 |
| -and is free of security vulnerabilities. |
| 3 | +Please see the Policy SIG |
| 4 | +[Contributing guide](https://github.com/open-cluster-management-io/community/blob/main/sig-policy/contribution-guidelines.md) |
| 5 | +to learn how to get involved. |
0 commit comments