Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add governance doc #927

Merged
merged 1 commit into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Kubean Project Governance

### 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")**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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")**.
Kubean community users, feel free to feedback your use of Kubean 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

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:

1. Engage in lively discussions in [Github Issues](https://github.com/kubean-io/kubean/issues "Github Issues").
2. Submit code patches.
3. Translate, revise, add to, and improve the [documentation](https://kubean-io.github.io/kubean/ "Documentation");
4. Share experiences with the Kubean project and actively promote it.
5. Submit suggestions/criticisms.

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


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

The CTC has final authority over this project, which includes:

* Setting the technical direction
* Establishing project governance and processes (including this policy)
* Managing the contribution policy
* Overseeing the GitHub repository hosting
* Enforcing conduct guidelines
* Maintaining the list of additional Collaborators

The Core Technical Committee consists of Reviewers & Approvers, see **[OWNERS](https://github.com/kubean-io/kubean/blob/main/OWNERS "OWNERS")** for a list.

### 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/issues "GitHub Milestone") for managing project progress and planning.

### 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`.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,14 @@ To check the list of Kubernetes versions supported by Kubean, please refer to th

Please visit: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)

## :thumbsup: Contributors

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

---

<div align="center">
<p>
<img src="https://landscape.cncf.io/images/left-logo.svg" width="300"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="350"/>
Expand Down