docs: add the governance and other improvements #8
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| # KubeFleet Project Governance | ||
|
|
||
| The KubeFleet project is dedicated to solving the challenges stemming from running and managing cloud native applications | ||
| on multi-clusters environment which includes multi-cloud and hybrid-cloud. | ||
| This governance explains how the project is run. | ||
|
|
||
| - [Values](#values) | ||
| - [Maintainers](#maintainers) | ||
| - [Becoming a Maintainer](#becoming-a-maintainer) | ||
| - [Meetings](#meetings) | ||
| - [CNCF Resources](#cncf-resources) | ||
| - [Code of Conduct Enforcement](#code-of-conduct) | ||
| - [Security Response Team](#security-response-team) | ||
| - [Voting](#voting) | ||
| - [Modifications](#modifying-this-charter) | ||
|
|
||
| ## Values | ||
|
|
||
| The KubeFleet and its leadership embrace the following values: | ||
|
|
||
| * Openness: Communication and decision-making happens in the open and is discoverable for future | ||
| reference. As much as possible, all discussions and work take place in public | ||
| forums and open repositories. | ||
|
|
||
| * Fairness: All stakeholders have the opportunity to provide feedback and submit | ||
| contributions, which will be considered on their merits. | ||
|
|
||
| * Community over Product or Company: Sustaining and growing our community takes | ||
| priority over shipping code or sponsors' organizational goals. Each | ||
| contributor participates in the project as an individual. | ||
|
|
||
| * Inclusivity: We innovate through different perspectives and skill sets, which | ||
| can only be accomplished in a welcoming and respectful environment. | ||
|
|
||
| * Participation: Responsibilities within the project are earned through | ||
| participation, and there is a clear path up the contributor ladder into leadership | ||
| positions. | ||
|
|
||
| ## Maintainers | ||
|
|
||
| KubeFleet Maintainers have write access to the [project GitHub repository](https://github.com/kubefleet-dev/kubefleet). | ||
| They can merge their own patches or patches from others. The current maintainers | ||
| can be found in [MAINTAINERS.md](./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 KubeFleet 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 should be able to demonstrate the following: | ||
| * commitment to the project: | ||
| * participate in discussions, contributions, code and documentation reviews for 3 months or more, | ||
| * perform reviews for 5 non-trivial pull requests, | ||
| * contribute 5 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 | ||
| [developer mailing list](https://groups.google.com/g/kubefleet-dev). 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 [private maintainer mailing list](https://groups.google.com/g/kubefleet-dev-private). | ||
|
|
||
| ### Bootstrapping Maintainers | ||
|
|
||
| To bootstrap the process, 3 maintainers are defined in the initial PR adding | ||
| this to the repository that have been working in this project for the past three years. | ||
|
|
||
|
|
||
| ### Size of the Maintainers | ||
|
|
||
| We will keep the total number of maintainers to be equal or less than seven to make sure that all maintainers are actively contributing to the project's success. | ||
|
|
||
| ### 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 6 months 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. | ||
|
|
||
| ## Meetings | ||
|
|
||
| Time zones permitting, Maintainers are expected to participate in the public | ||
| developer meeting, which occurs weekly. The meeting is open to all community. | ||
|
|
||
| Maintainers will also have closed meetings in order to discuss security reports | ||
| or Code of Conduct violations. Such meetings should be scheduled by any | ||
| Maintainer on receipt of a security issue or CoC report. All current Maintainers | ||
| must be invited to such closed meetings, except for any Maintainer who is | ||
| accused of a CoC violation. | ||
|
|
||
| ## CNCF Resources | ||
|
|
||
| Any Maintainer may suggest a request for CNCF resources, either in the | ||
| [mailing list](https://groups.google.com/g/kubefleet-dev), or during a | ||
| meeting. A simple majority of Maintainers approves the request. The Maintainers | ||
| may also choose to delegate working with the CNCF to non-Maintainer community | ||
| members, who will then be added to the [CNCF's Maintainer List](https://github.com/cncf/foundation/blob/main/project-maintainers.csv) | ||
| for that purpose. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| [Code of Conduct](./CODE_OF_CONDUCT.md) | ||
| violations by community members will be discussed and resolved | ||
| on the [private Maintainer mailing list](https://groups.google.com/g/kubefleet-dev-private). If a Maintainer is directly involved | ||
| in the report, the Maintainers will instead designate two Maintainers to work | ||
| with the CNCF Code of Conduct Committee in resolving it. | ||
|
|
||
| ## Security Response Team | ||
|
|
||
| The Maintainers will appoint a Security Response Team to handle security reports. | ||
| This committee may simply consist of the Maintainer Council themselves. If this | ||
| responsibility is delegated, the Maintainers will appoint a team of at least two | ||
| contributors to handle it. The Maintainers will review who is assigned to this | ||
| at least once a year. | ||
|
|
||
| The Security Response Team is responsible for handling all reports of security | ||
| holes and breaches according to the [security policy](SECURITY.md). | ||
|
|
||
| ## Voting | ||
|
|
||
| While most business in KubeFleet is conducted by "[lazy consensus](https://community.apache.org/committers/lazyConsensus.html)", | ||
| periodically the Maintainers may need to vote on specific actions or changes. | ||
| A vote can be taken on [the developer mailing list](https://groups.google.com/g/kubefleet-dev) or | ||
| [the private Maintainer mailing list](https://groups.google.com/g/kubefleet-dev-private) for security or conduct matters. | ||
| Votes may also be taken at [the developer meeting](#meetings).. Any Maintainer may | ||
| demand a vote be taken. | ||
|
|
||
| Most votes require a simple majority of all Maintainers to succeed, except where | ||
| otherwise noted. Two-thirds majority votes mean at least two-thirds of all | ||
| existing maintainers. | ||
|
|
||
| ## Modifying this Charter | ||
|
|
||
| Changes to this Governance and its supporting documents MUST be approved by | ||
| a 2/3 vote of the Maintainers. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,7 @@ | ||
| # The KubeFleet Maintainers | ||
|
|
||
| | Maintainer | Organization | GitHub Username | | ||
| |-------------|--------------|-------------------------------------------------------| | ||
| | Ryan Zhang | Microsoft | [@ryanzhang-oss](https://github.com/ryanzhang-oss) | | ||
| | Zhiying Lin | Microsoft | [@zhiying-lin](https://github.com/zhiying-lin) | | ||
| | Chen Yu | Microsoft | [@michaelawyu](https://github.com/michaelawyu) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this still link to the releases on the Azure github?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason why these links are still on here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need something for now, will replace it when we have kubefleet release