chore: update policy documents

Signed-off-by: Abhinandan Purkait <[email protected]>
openebs · May 8, 2024 · 60c7748 · 60c7748
1 parent edeb331
commit 60c7748
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 71 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,8 @@
-## Community Code of Conduct
+# Code of Conduct
+<BR>
 
-This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/HEAD/code-of-conduct.md).
+## Umbrella Project
+OpenEBS is an "umbrella project". Every project, repository and file in the OpenEBS organization adopts and follows the policies found in the Community repo umbrella project files.
+<BR>
+
+This project follows the [OpenEBS Code of Conduct](https://github.com/openebs/community/CODE_OF_CONDUCT.md)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,61 +1,18 @@
-# Contributing
+# Contributing Guidelines
+<BR>
 
-OpenEBS uses the standard GitHub pull requests process to review and accept contributions.  There are several areas that could use your help. For starters, you could help in improving the sections in this document by either creating a new issue describing the improvement or submitting a pull request to this repository. The issues for the various OpenEBS components (including components in this repository) are maintained in [openebs/openebs](https://github.com/openebs/openebs/issues) repository.
+## Umbrella Project
+OpenEBS is an "umbrella project". Every project, repository and file in the OpenEBS organization adopts and follows the policies found in the Community repo umbrella project files.
+<BR>
 
-* If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with `@...`) the maintainer of this repository (see [MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.
+This project follows the [OpenEBS Contributor Guidelines](https://github.com/openebs/community/CONTRIBUTING.md)
 
-* If you would like to work on something more involved, please connect with the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/HEAD/community).
+# Contributing Guidelines
+<BR>
 
-## Steps to Contribute
+## Umbrella Project
+OpenEBS is an "umbrella project". Every project, repository and file in the OpenEBS organization adopts and follows the policies found in the Community repo umbrella project files.
+<BR>
 
-OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed with Developer Certificate of Origin. See [Sign your work](#sign-your-work).
-
-* Find an issue to work on or create a new issue. The issues are maintained at [openebs/openebs](https://github.com/openebs/openebs/issues). You can pick up from a list of [good-first-issues](https://github.com/openebs/openebs/labels/good%20first%20issue).
-* Claim your issue by commenting your intent to work on it to avoid duplication of efforts.
-* Fork the repository on GitHub.
-* Create a branch from where you want to base your work (usually `main`).
-* Make your changes. 
-* Commit your changes by making sure the commit messages convey the need and notes about the commit.
-* Push your changes to the branch in your fork of the repository.
-* Submit a pull request to the original repository. See [Pull Request checklist](#pull-request-checklist).
-
-## Pull Request Checklist
-
-* Rebase to the current main branch before submitting your pull request.
-* Commits should be as small as possible. Each commit should follow the checklist below:
-  - For code changes, add tests relevant to the fixed bug or new feature.
-  - Pass the compile and tests - includes spell checks, formatting, etc.
-  - Commit header (first line) should convey what changed.
-  - Commit body should include details such as why the changes are required and how the proposed changes.
-  - DCO Signed.
-* If your PR is not getting reviewed or you need a specific person to review it, please reach out to the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/HEAD/community).
----
-
-### Sign your work
-
-We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license. Please read [developer-certificate-of-origin](./contribute/developer-certificate-of-origin).
-
-Please certify it by just adding a line to every git commit message. Any PR with Commits which does not have DCO Signoff will not be accepted:
-
-```
-  Signed-off-by: Random J Developer <[email protected]>
-```
-
-or use the command `git commit -s -m "commit message comes here"` to sign-off on your commits.
-
-Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed.
-
----
-## Sign your work
-
-We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS project. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/HEAD/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message:
-
-```
-  Signed-off-by: Random J Developer <[email protected]>
-```
-
-Use your real name (sorry, no pseudonyms or anonymous contributions). The email id should match the email id provided in your GitHub profile.
-If you set your `user.name` and `user.email` in git config, you can sign your commit automatically with `git commit -s`.
-
-You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases) like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed.
+This project follows the [OpenEBS Contributor Guidelines](https://github.com/openebs/community/CONTRIBUTING.md)
 
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -1 +1,8 @@
-This is a OpenEBS sub project and abides by the [OpenEBS Project Governance](https://github.com/openebs/openebs/blob/HEAD/GOVERNANCE.md).
+# Governance
+<BR>
+
+## Umbrella Project
+OpenEBS is an "umbrella project". Every project, repository and file in the OpenEBS organization adopts and follows the policies found in the Community repo umbrella project files.
+<BR>
+
+This project follows the [OpenEBS Governance](https://github.com/openebs/community/GOVERNANCE.md)
diff --git a/MAINTAINERS b/MAINTAINERS
@@ -1,13 +1 @@
-# Official list of OpenEBS Maintainers.
-#
-# Names added to this file should be in the following format:
-#     Individual's name,@githubhandle, Company Name
-#
-# Please keep the below list sorted in ascending order.
-#
-#Maintainers
-"Kiran Mova",@kmova,MayaData
-"Vishnu Itta",@vishnuitta,MayaData
-
-#Reviewers
-"Prateek Pandey",@prateekpandey14,MayaData
+See [OpenEBS Maintainers](https://github.com/openebs/community/MAINTAINERS.md)