Add the governance (#2806)

* Add the governance Signed-off-by: utam0k <[email protected]> * fixup! Add the governance Signed-off-by: utam0k <[email protected]> * Add Reviwers Signed-off-by: utam0k <[email protected]> * fixup! Add Reviwers Signed-off-by: utam0k <[email protected]> * fixup! Add the governance Signed-off-by: utam0k <[email protected]> --------- Signed-off-by: utam0k <[email protected]>
youki-dev · Jun 5, 2024 · 75d71e0 · 75d71e0
1 parent d7105b2
commit 75d71e0
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 3 deletions.
diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md
@@ -1,3 +1 @@
-## The Youki Project Community Code of Conduct
-
-The Youki Project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).
+Move to containers.github.io/youki/community/governance.html#code-of-conduct
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -16,6 +16,13 @@
 
 ---
 
+- [Community](./community/introduction.md)
+    - [Maintainer](./community/maintainer.md)
+    - [Governance](./community/governance.md)
+    - [Contributing](./community/contributing.md)
+
+---
+
 - [Developer Documentation](./developer/introduction.md)
   - [Basics](./developer/basics.md)
   - [Unwritten Rules](./developer/unwritten_rules.md)

diff --git a/docs/src/community/contributing.md b/docs/src/community/contributing.md
@@ -0,0 +1,19 @@
+# Contributing
+
+## Developer Certificate of Origin
+
+Every commit must be signed off with the `Signed-off-by: REAL NAME <[email protected]>` line.
+Use the `git commit -s` command to add the Signed-off-by line.
+
+## Licensing 
+
+Youki is licensed under the terms of [Apache License 2.0](https://github.com/containers/youki/blob/main/LICENSE).
+
+## Sending pull requests
+
+Pull requests can be submitted using [the GitHub standard process](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+## Merging pull requests
+
+Committers can merge pull requests.
+A Committer shouldn’t merge their own pull requests without approval by at least one other Committer.
diff --git a/docs/src/community/governance.md b/docs/src/community/governance.md
@@ -0,0 +1,40 @@
+# Code of Conduct
+
+Youki follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
+
+# Maintainership
+
+Youki is governed by Maintainers who are elected from active contributors.
+Youki will remain [vendor-nutral](https://contribute.cncf.io/maintainers/community/vendor-neutrality/).
+Maintainers are [here](./maintainer.md).
+
+## Roles
+
+Maintainers consist of the following roles:
+
+- Committer (Full maintainership)  
+    Committers have full write accesses to repos.
+    Committers’ commits should still be made via GitHub pull requests (except for urgent security fixes), and should not be pushed directly to the default branch.
+
+- Reviewer (Limited maintainership)  
+    Reviewers may moderate GitHub issues and pull requests (such as adding labels and cleaning up spams), but they do not have any access to merge pull requests nor push commits.
+    A Reviewer is considered as a candidate to become a Committer.
+
+## Addition and promotion of Maintainers
+
+A contributor who have made significant contributions in quality and in quantity can be directly invited as a Committer.
+A proposal to add or promote a Maintainer must be approved by 2/3 of the Committers who vote within 7 days.
+Voting needs a minimum of 2 approvals. The proposer can vote too. Votes from the same company will be counted as one vote.
+A proposal should be made via a GitHub pull request to the file containing the list of Maintainer defined above.
+Before submitting the pull request, the proposer should reach out to the Committers to check their willingness to support the proposal.
+
+## Removal and demotion of Maintainers
+
+A Maintainer who do not show significant activities for 12 months, or, who violated the Code of Conduct, may be demoted or removed from the project.
+
+A proposal to demote or remove a Maintainer must be approved by 2/3 of the Committers (excluding the person in question) who vote within 14 days.
+Voting needs a minimum of 2 approvals. The proposer can vote too. Votes from the same company will be counted as one vote.
+
+A proposal should be made via a GitHub pull request to the file containing the list of Maintainer defined above.
+In the special case of removing a harmful Maintainer, this process can take place via a private discussion.
+Before submitting the pull request, the proposer should reach out to the Committers to check their willingness.
diff --git a/docs/src/community/introduction.md b/docs/src/community/introduction.md
@@ -0,0 +1,5 @@
+# Community
+
+- [Maintainer](./maintainer.md)
+- [Governance](./goversance.md)
+- [Contributing](./contributing.md)
diff --git a/docs/src/community/maintainer.md b/docs/src/community/maintainer.md
@@ -0,0 +1,10 @@
+# Current Maintainers
+
+| Name            | Role      | GitHub ID                                          |
+|-----------------|-----------|----------------------------------------------------|
+| Toru Komatsu    | Committer | [@utam0k](https://github.com/utam0k)               |
+| Thomas Schubart | Committer | [@Furisto](https://github.com/Furisto)             |
+| Yashodhan       | Committer | [@YJDoc2](https://github.com/YJDoc2)               |
+| Eric Fang       | Committer | [@yihuaf](https://github.com/yihuaf)               |
+| Sascha Grunert  | Committer | [@saschagrunert](https://github.com/saschagrunert) |
+| Jorge Prendes   | Committer | [@jprendes](https://github.com/jprendes)           |