Skip to content

Commit

Permalink
Merge pull request kubean-io#1220 from tu1h/update_docs
Browse files Browse the repository at this point in the history
Update README and GOVERNANCE md
  • Loading branch information
ErikJiang authored Apr 30, 2024
2 parents 59f032d + 925f2ad commit 9871686
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 6 deletions.
69 changes: 64 additions & 5 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 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")**.

The community welcomes any individuals, companies, and organizations to use, contribute to, report bugs, submit feature requests, and help each other.

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:

Expand All @@ -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.

Expand All @@ -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`.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Kubean is a product ready cluster lifecycle management toolchains based on [kube
<img src="https://github.com/cncf/artwork/blob/main/other/illustrations/ashley-mcnamara/transparent/cncf-cloud-gophers-transparent.png" style="width:700px;" />
</p>

**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

Expand Down Expand Up @@ -114,12 +114,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

<a href="https://github.com/kubean-io/kubean/graphs/contributors">
<img src="https://contrib.rocks/image?repo=kubean-io/kubean" />
</a>

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

---

<div align="center">
Expand Down
20 changes: 20 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: 贡献者

<a href="https://github.com/kubean-io/kubean/graphs/contributors">
<img src="https://contrib.rocks/image?repo=kubean-io/kubean" />
</a>

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

<div align="center">
<p>
<img src="https://landscape.cncf.io/images/cncf-landscape-horizontal-color.svg" width="300"/>
Expand Down

0 comments on commit 9871686

Please sign in to comment.