Skip to content

Commit

Permalink
Reference the SIG contribution guidelines (#26)
Browse files Browse the repository at this point in the history
Signed-off-by: mprahl <[email protected]>
  • Loading branch information
mprahl authored Apr 26, 2022
1 parent fbf6071 commit 65153ee
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 57 deletions.
60 changes: 4 additions & 56 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,5 @@
**Table of Contents**
# Contributing Guide

- [Contributing guidelines](#contributing-guidelines)
- [Terms](#terms)
- [Certificate of Origin](#certificate-of-origin)
- [DCO Sign Off](#dco-sign-off)
- [Code of Conduct](#code-of-conduct)
- [Contributing a patch](#contributing-a-patch)
- [Issue and pull request management](#issue-and-pull-request-management)
- [Pre-check before submitting a PR](#pre-check-before-submitting-a-pr)

# Contributing guidelines

## Terms

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).

## Certificate of Origin

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-io/community/blob/main/DCO) file for details.

## DCO Sign Off

You must sign off your commit to state that you certify the [DCO](https://github.com/open-cluster-management-io/community/blob/main/DCO). To certify your commit for DCO, add a line like the following at the end of your commit message:

```
Signed-off-by: John Smith <[email protected]>
```

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.

## Code of Conduct

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-io/community/blob/main/CODE_OF_CONDUCT.md) for details.

## Contributing a patch

1. Submit an issue describing your proposed change to the repository in question. The repository owners will respond to your issue promptly.
2. Fork the desired repository, then develop and test your code changes.
3. Submit a pull request.

## Issue and pull request management

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).

## Pre-check before submitting a PR
<!-- Customize this template for your repository -->

Before submitting a PR, please perform the following steps:

- Run steps in [Running tests](README.md#running-tests) in order to verify that the unit and E2E tests are passing.

## Post-submit FOSSA License and Security Scan

After the Pull Request is submitted, a [FOSSA](https://fossa.com/) scan is run through a GitHub
action. The scan will verify that the code and its dependencies comply with open source licensing
and is free of security vulnerabilities.
Please see the Policy SIG
[Contributing guide](https://github.com/open-cluster-management-io/community/blob/main/sig-policy/contribution-guidelines.md)
to learn how to get involved.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Every reconcile does the following things:

1. Creates/updates the policy status on the hub and managed cluster in cluster namespace

## Geting started
## Geting started

Go to the
[Contributing guide](https://github.com/open-cluster-management-io/community/blob/main/sig-policy/contribution-guidelines.md)
to learn how to get involved.

Check the [Security guide](SECURITY.md) if you need to report a security issue.

Expand Down

0 comments on commit 65153ee

Please sign in to comment.