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

Add governance doc #927

merged 1 commit into from
Aug 7, 2023

Conversation

ErikJiang
Copy link
Member

@ErikJiang ErikJiang commented Aug 7, 2023

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Add kubean open source community governance description document.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Copy link
Contributor

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

Some test suggestions

GOVERNANCE.md Outdated

### Core Technical Committee

The Kubean project is governed and directed by a Core Technical Committee, which is responsible for the development of the Kubean project.
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
The Kubean project is governed and directed by a Core Technical Committee, which is responsible for the development of the Kubean project.
The Kubean project is governed and directed by a Core Technical Committee (CTC), which is responsible for the development of the Kubean project.

GOVERNANCE.md Outdated

The Kubean project is governed and directed by a Core Technical Committee, which is responsible for the development of the Kubean project.

The CTC has final authority over this project including:
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
The CTC has final authority over this project including:
The CTC has final authority over this project, which includes:

GOVERNANCE.md Outdated
Comment on lines 29 to 36
* Technical direction
* Project governance and process (including this policy)
* Contribution policy
* GitHub repository hosting
* Conduct guidelines
* Maintaining the list of additional Collaborators
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
* Technical direction
* Project governance and process (including this policy)
* Contribution policy
* GitHub repository hosting
* Conduct guidelines
* Maintaining the list of additional Collaborators
* 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

GOVERNANCE.md Outdated
Comment on lines 39 to 40
1. we recommend [Github Issue](https://github.com/kubean-io/kubean/issues "Github Issue") for tracking bugs and managing requirements.
2. we recommend [Github Milestone](https://github.com/kubean-io/kubean/issues "GitHub Milestone") for managing project progress and planning;
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
1. we recommend [Github Issue](https://github.com/kubean-io/kubean/issues "Github Issue") for tracking bugs and managing requirements.
2. we recommend [Github Milestone](https://github.com/kubean-io/kubean/issues "GitHub Milestone") for managing project progress and planning;
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.

GOVERNANCE.md Outdated

### 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`.
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
2. we recommend using [Github Wiki](https://github.com/kubean-io/kubean/wiki "Github Wiki") to deposit FAQs; `TODO`.
2. We recommend using [Github Wiki](https://github.com/kubean-io/kubean/wiki "Github Wiki") to deposit FAQs; `TODO`.

GOVERNANCE.md Outdated

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, develop, feedback bugs, submit feature requests, and help each other. We recommend using [Github Issue](https://github.com/kubean-io/kubean/issues "Github Issue") to track bugs and manage requests.
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
The community welcomes any individuals, companies, and organizations to use, develop, feedback bugs, submit feature requests, and help each other. We recommend using [Github Issue](https://github.com/kubean-io/kubean/issues "Github Issue") to track bugs and manage requests.
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.

GOVERNANCE.md Outdated

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. participate in the community by actively engaging in discussions in [Github Issue](https://github.com/kubean-io/kubean/issues "Github Issue").
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
1. participate in the community by actively engaging in discussions in [Github Issue](https://github.com/kubean-io/kubean/issues "Github Issue").
1. engage in lively discussions in [Github Issues](https://github.com/kubean-io/kubean/issues "Github Issues").

Copy link
Member Author

Choose a reason for hiding this comment

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

😁Thanks, @windsonsea, I'm done.


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

GOVERNANCE.md Outdated

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").
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
1. engage in lively discussions in [Github Issues](https://github.com/kubean-io/kubean/issues "Github Issues").
1. Engage in lively discussions in [Github Issues](https://github.com/kubean-io/kubean/issues "Github Issues").

GOVERNANCE.md Outdated
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.
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
2. submit code patches.
2. Submit code patches.

GOVERNANCE.md Outdated

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");
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
3. translate, revise, add to, and improve the [documentation](https://kubean-io.github.io/kubean/ "Documentation");
3. Translate, revise, add to, and improve the [documentation](https://kubean-io.github.io/kubean/ "Documentation");

GOVERNANCE.md Outdated
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.
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
4. share experiences with the Kubean project and actively promote it.
4. Share experiences with the Kubean project and actively promote it.

GOVERNANCE.md Outdated
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.
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
5. submit suggestions/criticisms.
5. Submit suggestions/criticisms.

GOVERNANCE.md Outdated
4. share experiences with the Kubean project and actively promote it.
5. submit suggestions/criticisms.

Prominent contributors can expect to be included in the Kubean project's [Maintainers List](https://github.com/kubean-io/kubean/blob/main/MAINTAINERS.md).
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
Prominent contributors can expect to be included in the Kubean project's [Maintainers List](https://github.com/kubean-io/kubean/blob/main/MAINTAINERS.md).
Prominent contributors can be included in the Kubean project's [Maintainers List](https://github.com/kubean-io/kubean/blob/main/MAINTAINERS.md).

Copy link
Member Author

Choose a reason for hiding this comment

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

hi @Michelle951, I'm done.😀

Copy link
Contributor

Choose a reason for hiding this comment

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

/lgtm

Signed-off-by: bo.jiang <[email protected]>
@kubean-pr-robot kubean-pr-robot bot added the lgtm Indicates that a PR is ready to be merged. label Aug 7, 2023
@ErikJiang ErikJiang merged commit cbdcb82 into kubean-io:main Aug 7, 2023
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants