diff --git a/CONTRIBUTOR_LADDER.md b/CONTRIBUTOR_LADDER.md new file mode 100644 index 0000000..f3e6e7c --- /dev/null +++ b/CONTRIBUTOR_LADDER.md @@ -0,0 +1,161 @@ +# Contributor Ladder Template + +* [Contributor Ladder](#contributor-ladder-template) + * [Contributor](#contributor) + * [Organization Member](#organization-member) + * [Reviewer](#reviewer) + * [Maintainer](#maintainer) +* [Inactivity](#inactivity) +* [Involuntary Removal](#involuntary-removal-or-demotion) +* [Stepping Down/Emeritus Process](#stepping-downemeritus-process) +* [Contact](#contact) + + +## Contributor Ladder + +Hello! We are excited that you want to learn more about our project contributor ladder! This contributor ladder outlines the different contributor roles within the project, along with the responsibilities and privileges that come with them. Community members generally start at the first levels of the "ladder" and advance up it as their involvement in the project grows. Our project members are happy to help you advance along the contributor ladder. + +Each of the contributor roles below is organized into lists of three types of things. "Responsibilities" are things that contributor is expected to do. "Requirements" are qualifications a person needs to meet to be in that role, and "Privileges" are things contributors on that level are entitled to. + +Open Cluster Management is a project made up of several Subprojects, such as Foundation and Policy. This contributor ladder applies to each Subproject. As such, a contributor advances in each Subproject separately, and may be a Member in one Subproject while being a Maintainer in another. For the Open Cluster Management project overall, the contributor is considered to be the highest level they have reached in any Subproject. Thus, someone who is a Project Member in one Subproject is a Project Member of OCM overall. + +### Contributor + +Description: A Contributor contributes directly to the project and adds value to it. Contributions need not be code. People at the Contributor level may be new contributors, or they may only contribute occasionally. + +* Responsibilities include: + * Follow the CNCF CoC + * Follow the project contributing guide +* Requirements (one or several of the below): + * Sign the DCO for Open Cluster Management, either individually or through their employer + * Report and sometimes resolve issues + * Occasionally submit PRs + * Contribute to the documentation + * Show up at meetings, takes notes + * Answer questions from other community members + * Submit feedback on issues and PRs + * Test releases and patches and submit reviews + * Run or helps run events + * Promote the project in public + * Help run the project infrastructure +* Privileges: + * Invitations to contributor events + * Eligible to become an Organization Member + + +### Organization Member +Description: An Organization Member is an established contributor who regularly participates in the project. Organization Members have privileges in both project repositories and elections, and as such are expected to act in the interests of the whole project. While Organization Members are selected by individual subprojects, some of their requirements and privileges apply to the entire OCM project. + +An Organization Member must meet the responsibilities and has the requirements of a Contributor, plus: + +* Responsibilities include: + * Continues to contribute regularly, as demonstrated by having at least 25 contributions a year, as demonstrated by Devstats project metrics. +* Requirements: + * Must have successful contributions to the project, including at least one of the following: + * 2 accepted PRs, + * Reviewed 3 PRs, + * Resolved and closed 5 Issues, + * Become responsible for a key project management area, + * Or some equivalent combination or contribution + * Must have been contributing for at least 3 months + * Must be actively contributing to at least one project area + * Must have two sponsors who are also Organization Members + + * Enable 2FA on their GitHub account + +* Privileges: + * May be assigned Issues and Reviews + * May give commands to CI/CD automation + * Entitled to vote in the [TODO: appropriate election] + * Can be added to GitHub teams in the Open Cluster Management org + * Can recommend other contributors to become Org Members + +The process for a Contributor to become an Organization Member is as follows: + + +1. The contributor or an Org Member may propose them for membership in an Issue in the relevant Subproject. This issue will name at least two existing Org Members (sponsors) who can vouch for the contributor, and will list their existing contributions. +2. Both sponsors will +1 the request. +3. GitHub administrator will add the contributor to the GitHub organization, as well as to the relevant Subproject's general contributor Team. + +### Reviewer + + +Description: A Reviewer has responsibility for specific code, documentation, test, or other project areas. They are collectively responsible, with other Reviewers, for reviewing all changes to those areas and indicating whether those changes are ready to merge. They have a track record of contribution and review in the project. + +Reviewers are responsible for a "specific area." This can be a specific code directory, driver, chapter of the docs, test job, event, or other clearly-defined project component that is smaller than an entire repository or subproject. Most often it is one or a set of directories in one or more Git repositories. The "specific area" below refers to this area of responsibility. + +Reviewers have all the rights and responsibilities of an Organization Member, plus: + +* Responsibilities include: + * Following the reviewing guide + * Reviewing most Pull Requests against their specific areas of responsibility + * Reviewing at least 10 PRs per year + * Helping other contributors become reviewers +* Requirements: + * Experience as a Contributor for at least 3 months + * Is an Organization Member + * Has reviewed, or helped review, at least 10 Pull Requests + * Has analyzed and resolved test failures in their specific area + * Has demonstrated an in-depth knowledge of the specific area + * Commits to being responsible for that specific area + * Is supportive of new and occasional contributors and helps get useful PRs in shape to commit +* Additional privileges: + * Has GitHub or CI/CD rights to approve pull requests in specific directories + * Can recommend and review other contributors to become Reviewers + +The process of becoming a Reviewer is: + +1. The contributor is nominated by opening a PR against the appropriate repository, which adds their GitHub username to the OWNERS file for one or more directories. +2. At least two members of the team that owns that repository or main directory, who are already Approvers, approve the PR. + +### Maintainer +Description: Maintainers are very established contributors who are responsible for one or more Subprojects. As such, they have the ability to approve PRs against any area of that Subproject, and are expected to participate in making decisions about the strategy and priorities of that Subproject and Open Cluster Management as a whole. + +A Maintainer must meet the responsibilities and requirements of a Reviewer, plus: + +* Responsibilities include: + * Reviewing at least 20 PRs per year, especially PRs that involve multiple parts of the project + * Mentoring new Reviewers + * Writing refactoring PRs + * Participating in CNCF maintainer activities + * Determining strategy and policy for the project + * Participating in, and leading, community meetings +* Requirements + * Experience as a Reviewer for at least 3 months + * Demonstrates a broad knowledge of the project across multiple areas + * Is able to exercise judgement for the good of the project, independent of their employer, friends, or team + * Mentors other contributors + * Can commit to spending at least 15 hours per month working on the project +* Additional privileges: + * Added to root OWNERs file in one or more Subprojects + * Approve PRs to any area of those Subprojects + * Represent the project in public as a Maintainer + * Communicate with the CNCF on behalf of the project + * Have a vote in Maintainer decision-making meetings + + +Process of becoming a maintainer: +1. Any current Maintainer may nominate a current Reviewer to become a new Maintainer, by opening a PR against the root of the Subproject's primary repository, adding the nominee as an Approver in the OWNERS file. +2. The nominee will add a comment to the PR testifying that they agree to all requirements of becoming a Maintainer. +3. A majority of the current Maintainers of that Subproject must then approve the PR. + +## Inactivity +It is important for contributors to be and stay active to set an example and show commitment to the project. Inactivity is harmful to the project as it may lead to unexpected delays, contributor attrition, and a loss of trust in the project. + +* Inactivity is measured by: + * Periods of no contributions for longer than 18 months + * Unannounced periods of no communication for longer than 4 months +* Consequences of being inactive include: + * Involuntary removal or demotion + * Being asked to move to Emeritus status + +## Involuntary Removal or Demotion + +Involuntary removal/demotion of a contributor happens when responsibilities and requirements aren't being met. This may include repeated patterns of inactivity, extended period of inactivity, a period of failing to meet the requirements of your role, and/or a violation of the Code of Conduct. This process is important because it protects the community and its deliverables while also opens up opportunities for new contributors to step in. + +Involuntary removal or demotion is handled through a vote by a majority of the current Maintainers of the relevant Subproject, or in some cases a majority of all Maintainers for OCM. + +## Stepping Down/Emeritus Process +If and when contributors' commitment levels change, contributors can consider stepping down (moving down the contributor ladder) vs moving to emeritus status (completely stepping away from the project). + +Contact the Maintainers about changing to Emeritus status, or reducing your contributor level. diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..9870c89 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,169 @@ +# Open Cluster Management Project Governance + +* [Values](#values) +* [Individual Subproject Governance](#individual-Subproject-governance) +* [Steering Committee](#steering-committee) + * [Steering Committee Duties](#steering-committee-duties) + * [Steering Committee Elections](#steering-committee-elections) +* [Code of Conduct Committee](@code-of-conduct-committee) +* [Adding New Subprojects](#adding-new-Subprojects) +* [Removing Projects](#removing-projects) + +The Open Cluster Management umbrella project is composed as a federation of individual projects, +some independent and some interdependent, each of which focuses on some aspect +of Kubernetes cluster and multicluster management. Our governance reflects this federated structure. + +## Values + +Open Cluster Management and its leadership embrace the following values: + +* Openness: Open Cluster Management is an open source community driven project. +* Distributed design: Distributed asynchronous ownership, collaboration, communication and decision making are the cornerstones of our world-wide community. +* Fairness: Ideas and contributions are accepted according to their technical merit and alignment with project objectives, scope, and design principles. +* Diversity and inclusion: Everyone are welcome to participate in the Open Cluster Management project regardless of gender, gender identity, sexual orientation, disability, race, ethnicity, age, religion or economic status. + +## Individual Subproject Governance + +All active Maintainers of each Subproject, as defined in the Contributor Ladder, are +members of that project's Maintainer Committee, which governs that project. The +Subproject's Maintainer Committee is responsible for the following project governance +activities: + +* Ensuring that the Subproject creates and publishes regular releases; +* Holding regular, Subproject-wide discussions on issues and planning; +* Monthly review of project contributors for advancement on the Contributor Ladder; +* Making final decisions on Subproject changes that involve controversial trade-offs; +* Responding to security compromise reports; +* Supporting the Code of Conduct within their Subproject and referring violations + to the Code of Conduct Committee. + +Additionally, the project's Maintainer Committee will select, by majority vote, one +representative to the Steering Committee. This representative need not +be a member of the Subproject's Maintainer Committee, and will be replaced or +renewed by the committee annually. + +Should a member of the Maintainer Committee cease being active in the Subproject, +violate the Code Of Conduct, or need to be removed for some other reason, they +may be removed by a 2/3 majority vote of the other Committee members, or a +majority vote of the Steering Committee. + +## Steering Committee + +The overall Open Cluster Management umbrella project is governed by a Steering +Committee, which is selected as follows: + +* One Maintainer representatives from each member Subproject +* Two general "Community Representatives" + +### Steering Committee Duties + +The Steering Committee is responsible for the following tasks, any of which may +be delegated to a person or group selected by the committee: + +* Reviewing and deciding on new projects to add to Open Cluster Management +* Arbitrating inter-project disagreements +* Selecting the Code of Conduct Committee and ratifying CoC judgements +* Removing projects which have become inactive +* Acting on escalated security or code quality issues +* Resolving issues that individual projects are unable to resolve +* Administering project infrastructure, intellectual property, and resources +* Determining overall direction for advocacy and marketing +* Issuing statements on behalf of Open Cluster Management and its Subprojects +* Reviewing and approving Contributor Ladder advancement for participants who + work on the overall umbrella project + +In performance of these duties, the Steering Committee will hold a monthly meeting +that is open to all contributors. The Committee may hold additional, closed meetings +in order to discuss non-public issues such as security exploits, CoC enforcement, +and legal questions. + +Steering Committee members are expected to advocate for all of Open Cluster Management, not just +certain projects or corporate sponsors, comply with and support the Code of +Conduct, and be professional and compassionate in all of their dealings with +project participants. + +### Steering Committee Elections + +The Community Representative(s) will be elected by the collective Organization Members +of all Subprojects, as defined in the Contributor Ladder. They +will be elected annually. + +Once per year, the Steering Committee will select between two and three Election +Officers to run the annual election and sets the dates for the election. Election +Officers should be project Members in good standing, not running for election +themselves, and represent more than one project employer. + +These officers will update the list of eligible Members according to +project records, send out announcements, and conduct the election. The election +starts with a call for nominations, which lasts for at least one week, and will +include a period for project Members to request changes to their voting status. +Candidates may nominate themselves, or they may be nominated by their colleagues. + +The election itself will last for at least one week, and is conducted as a +preference election online, using a method such as Condorcet or IRV. The +Election Officers will announce the selected candidates at the next regular +community meeting. + +## Code of Conduct Committee + +In order to review and enforce the Code of Conduct, the Steering Committee selects +3 people to be on the Code of Conduct Committee. + +These individuals will be chosen based on their community management and code of conduct +experience, with diverse representation across the committee, including employer, gender, +race, background, and region of the world. To avoid fatigue, the Steering Committee will +replace at least 1 member of the CoC Committee each year. Members of the +committee do not need to be members of Open Cluster Management if they have sufficient other +expertise. + +The CoC Committee will receive reports of conduct violations confidentially, +and will discuss them in closed meetings. If a report is determined to be a +violation, they will recommend action on it appropriate to the scale, nature, +and context of the violation, from requiring an apology, up to expulsion of an +individual from the project. In the event that a contributor is to be demoted +or expelled, the CoC Committee will forward this recommendation to the Steering +Committee who will ratify it in a closed meeting. Should a member of the +Steering Committee be the offender or the reporter, this recommendation will +instead be forwarded to the CNCF staff for final arbitration. + +## Adding New Subprojects + +During the monthly Steering meeting, any project member may recommend projects +to become part of Open Cluster Management. These projects should have the following +characteristics: + +* Have a mission of Kubernetes cluster and multicluster management; +* Are appropriately licensed and governed or willing to become so; +* Are under active development; +* Consist of high quality code and designs. + +Before submitting an application to the Steering Committee, the applying project +must hold an internal consensus vote of all major contributors to join +Open Cluster Management. The Steering Committee will then review the +application, and decide whether or not to accept it. If it is accepted, the Committee +will assign one person to assist the Subproject in their integration. + +In some cases, promising but incomplete projects may be accepted as Experimental +Subprojects. Such Experimental Subprojects will be considered part of +Open Cluster Management, but will be marked as Experimental on the website and in code +repositories, in order to inform users. Experimental Subproject Members are considered +Members of Open Cluster Management, but the Subproject is not entitled to a representative on the +Steering Committee. Steering will review Experimental Subprojects at least twice +per year to determine if they have matured to full Subproject status. + +New Subprojects will be initialized with a set of maintainers, reviewers, +contributors, and other roles assigned based on the people doing the work before +the Subproject was accepted. The appropriate contributors will be added as +Organization Members without the regular process. + +## Removing Projects + +In some cases, projects will become inactive or unmaintainable, or wish to separate +from Open Cluster Management. Any Steering Committee member may propose removal of a project on +these grounds, and Steering can confirm this with a majority vote. The CNCF will +determine which, if any, assets of those subprojects will be removable should a +project leave OCM. + +Where possible, Projects which still have contributors will then be moved to a +repository in their own namespace. Projects which have ceased all activity are +moved to an archive namespace.