From 925f2adf2a45af1b3ae605e2593e05ac55706723 Mon Sep 17 00:00:00 2001 From: tu1h Date: Tue, 30 Apr 2024 15:39:28 +0800 Subject: [PATCH] Update README and GOVERNANCE md Signed-off-by: tu1h --- GOVERNANCE.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++---- README.md | 16 +++++++++++- README_zh.md | 20 +++++++++++++++ 3 files changed, 99 insertions(+), 6 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index cdb0de7ec..f53c9cf65 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1,6 +1,6 @@ # Kubean Project Governance -### User +## User Kubean community users, feel free to comment your usage information in **[Who is using Kubean](https://github.com/kubean-io/kubean/issues/910 "Who is Using Kubean")**. @@ -8,7 +8,7 @@ The community welcomes any individuals, companies, and organizations to use, con We recommend using [Github Issues](https://github.com/kubean-io/kubean/issues "Github Issues") to track bugs and manage requests. -### Contributor +## Contributor Every user is welcome to participate and contribute to the Kubean open-source community in a number of ways, including but not limited to the following: @@ -21,8 +21,66 @@ Every user is welcome to participate and contribute to the Kubean open-source co Prominent contributors can be included in the Kubean project's [Maintainers List](https://github.com/kubean-io/kubean/blob/main/MAINTAINERS.md). All contributors who have submitted PRs to Kubean will be permanently recorded in the [Contributors List](https://github.com/kubean-io/kubean#thumbsup-contributors). +## Maintainer -### Core Technical Committee +Kubean Maintainers have write access to the [Kubean](https://github.com/kubean-io/kubean). +They can merge their own patches or patches from others. The current maintainers +can be found in [MAINTAINERS.md](https://github.com/kubean-io/kubean/blob/main/MAINTAINERS.md). Maintainers collectively manage the project's +resources and contributors. + +This privilege is granted with some expectation of responsibility: maintainers +are people who care about the Kubean project and want to help it grow and +improve. A maintainer is not just someone who can make changes, but someone who +has demonstrated their ability to collaborate with the team, get the most +knowledgeable people to review code and docs, contribute high-quality code, and +follow through to fix issues (in code or tests). + +A maintainer is a contributor to the project's success and a citizen helping +the project succeed. + +The collective team of all Maintainers is known as the Maintainer Council, which +is the governing body for the project. + +### Becoming a Maintainer + +To become a Maintainer you need to demonstrate the following: + +- commitment to the project: + - participate in discussions, contributions, code and documentation reviews + for 6 month or more, + - perform reviews for 20 non-trivial pull requests, + - contribute 20 non-trivial pull requests and have them merged, +- ability to write quality code and/or documentation, +- ability to collaborate with the team, +- understanding of how the team works (policies, processes for testing and code review, etc), +- understanding of the project's code base and coding and documentation style. + +A new Maintainer must be proposed by an existing maintainer by sending a message to the +[bo.jiang@daocloud.io](bo.jiang@daocloud.io). A simple majority vote of existing Maintainers +approves the application. Maintainers nominations will be evaluated without prejudice +to employer or demographics. + +Maintainers who are selected will be granted the necessary GitHub rights, +and invited to the [xiao.zhang@daocloud.io](xiao.zhang@daocloud.io). + +### Removing a Maintainer + +Maintainers may resign at any time if they feel that they will not be able to +continue fulfilling their project duties. + +Maintainers may also be removed after being inactive, failure to fulfill their +Maintainer responsibilities, violating the Code of Conduct, or other reasons. +Inactivity is defined as a period of very low or no activity in the project +for a year or more, with no definite schedule to return to full Maintainer +activity. + +A Maintainer may be removed at any time by a 2/3 vote of the remaining maintainers. + +Depending on the reason for removal, a Maintainer may be converted to Emeritus +status. Emeritus Maintainers will still be consulted on some project matters, +and can be rapidly returned to Maintainer status if their availability changes. + +## Core Technical Committee The Kubean project is governed and directed by a Core Technical Committee (CTC), which is responsible for the development of the Kubean project. @@ -37,10 +95,11 @@ The CTC has final authority over this project, which includes: The Core Technical Committee consists of Reviewers & Approvers, see **[OWNERS](https://github.com/kubean-io/kubean/blob/main/OWNERS "OWNERS")** for a list. -### Communication +## Communication 1. We recommend using [Github Issues](https://github.com/kubean-io/kubean/issues "Github Issues") for tracking bugs and managing requirements; 2. We recommend using [Github Milestone](https://github.com/kubean-io/kubean/milestones "GitHub Milestone") for managing project progress and planning. +3. We recommend using [Kubean Slack](https://cloud-native.slack.com/messages/kubean) for questions and discussions. -### Documentation +## Documentation 1. We recommend using [Github Pages](https://kubean-io.github.io/kubean "Github Pages") to deposit the documentation; 2. We recommend using [Github Wiki](https://github.com/kubean-io/kubean/wiki "Github Wiki") to deposit FAQs; `TODO`. diff --git a/README.md b/README.md index 84e6589a8..f7217b8a7 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Kubean is a product ready cluster lifecycle management toolchains based on [kube

-**Kubean is a [Cloud Native Computing Foundation](https://cncf.io/) Landscape project.** +**Kubean is a [Cloud Native Computing Foundation sandbox project](https://cncf.io/).** ## :anchor: Awesome features @@ -113,12 +113,26 @@ For detailed information about all the planned features, please refer to the [ro Please visit: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/) +## :envelope: Communication + +You can connect with us on the following channels: + - Slack: join the [#Kubean](https://cloud-native.slack.com/messages/kubean) channel on CNCF Slack by requesting an [invitation](https://slack.cncf.io/) from CNCF Slack. Once you have access to CNCF Slack, you can join the Kubean channel. + - Email: refer to the [MAINTAINERS.md](./MAINTAINERS.md) to find the email addresses of all maintainers. Feel free to contact them via email to report any issues or ask questions. + ## :thumbsup: Contributors +## :mag_right: Others + +Copyright The Kubean Authors + +We are a [Cloud Native Computing Foundation sandbox project](https://www.cncf.io/). + +The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage). + ---
diff --git a/README_zh.md b/README_zh.md index e6b83f541..3a78f84a2 100644 --- a/README_zh.md +++ b/README_zh.md @@ -108,6 +108,26 @@ $ kubectl get pods -n kubean-system | grep 'kubean' 请浏览: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/) +## :envelope: 联系我们 + +你可以通过以下渠道与我们联系： + - Slack: 通过请求 CNCF Slack的[邀请](https://slack.cncf.io/)加入 CNCF Slack的 [#Kubean](https://cloud-native.slack.com/messages/kubean) 频道。一旦您可以访问 CNCF Slack，您就可以加入 Kubean 频道。 + - 电子邮件: 请参阅 [MAINTAINERS.md](./MAINTAINERS.md) 查找所有维护人员的电子邮件地址。随时通过电子邮件与他们联系，报告任何问题或提出问题。 + +## :thumbsup: 贡献者 + + + + + +## :mag_right: 其他 + +Copyright The Kubean Authors + +We are a [Cloud Native Computing Foundation sandbox project](https://www.cncf.io/). + +The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage). +