Skip to content

Commit 51408e0

Browse files
committed
Add initial draft of Podman project Governance
This is the initial version of the governance model we're looking to implement. It is still very early, and comments and suggestions are very welcome! Signed-off-by: Matt Heon <[email protected]>
1 parent 73795f4 commit 51408e0

File tree

1 file changed

+191
-0
lines changed

1 file changed

+191
-0
lines changed

GOVERNANCE.md

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# Contributor Ladder Template
2+
3+
* [Contributor Ladder](#contributor-ladder-template)
4+
* [Contributor](#contributor)
5+
* [Reviewer](#reviewer)
6+
* [Maintainer](#maintainer)
7+
* [Core Maintainer](#coremaintainer)
8+
* [Inactivity](#inactivity)
9+
* [Involuntary Removal](#involuntary-removal-or-demotion)
10+
* [Stepping Down/Emeritus Process](#stepping-downemeritus-process)
11+
* [Updates to this Document](#updates-to-this-document)
12+
* [Contact](#contact)
13+
14+
15+
## Contributor Ladder
16+
17+
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. At all levels, contributors are required to follow the CNCF Code of Conduct (COC).
18+
19+
Each of the project member roles below is organized into lists of three types of things.
20+
21+
* "Responsibilities" – functions of a member
22+
* "Requirements" – qualifications of a member
23+
* "Privileges" – entitlements of member
24+
25+
26+
### Contributor
27+
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.
28+
29+
* Responsibilities include:
30+
* Follow the CNCF CoC
31+
* Follow the project contributing guide
32+
* Requirements (one or several of the below):
33+
* Report and sometimes resolve issues against any of the project’s repositories
34+
* Occasionally submit PRs against any of the project’s repositories
35+
* Contribute to project documentation, including the manpages, tutorials, and Podman.io
36+
* Attend community meetings when reasonable
37+
* Answer questions from other community members on the mailing list, Slack, Matrix, and other communication channels
38+
* Assist in triaging issues
39+
* Assist in reviewing pull requests, including testing patches when applicable
40+
* Test release candidates and provide feedback
41+
* Promote the project in public
42+
* Help run the project infrastructure
43+
* Privileges:
44+
* Invitations to contributor events
45+
* Eligible to become a Reviewer
46+
47+
### Reviewer
48+
Description: A Reviewer has responsibility for the triage of issues and review of pull requests on the Podman project or a subproject, consisting of one or more of the Git repositories that form the project. They are collectively responsible, with other Reviewers, for reviewing changes to the repository or repositories and indicating whether those changes are ready to merge. They have a track record of contribution and review in the project.
49+
50+
Reviewers have all the rights and responsibilities of an Contributor, plus:
51+
52+
* Responsibilities include:
53+
* Regular contribution of pull requests to the Podman project or its subprojects
54+
* Triage of Github issues on the Podman project or its subprojects
55+
* Regularly fixing Github issues on the Podman project or its subprojects
56+
* Following the reviewing guide
57+
* A sustained high level of pull request reviews on the Podman project or one of its subprojects
58+
* Assisting new Contributors with the process of contributing
59+
* Helping other contributors become reviewers
60+
* Requirements:
61+
* Has a proven record of good-faith contributions to the project as a Contributor for a period of at least 6 months. The time requirement may be overridden by a supermajority vote of Maintainers.
62+
* Has participated in pull request review and/or issue triage on the project for at least 6 months. The time requirement may be overridden by a supermajority vote of Maintainers.
63+
* Is supportive of new and occasional contributors and helps get useful PRs in shape to merge
64+
* Additional privileges:
65+
* Has rights to approve pull requests in the Podman project or a subproject
66+
* Can recommend and review other contributors to become Reviewers
67+
68+
All Reviewers are listed in the OWNERS file of the repository or repositories they have review authority over.
69+
70+
71+
#### The process of becoming a Reviewer is:
72+
1. The contributor must be sponsored by a Maintainer. That sponsor will open a PR against the appropriate repository, which adds the contributor to the MAINTAINERS.md file as a reviewer.
73+
2. The contributor will add a comment to the pull request indicating their willingness to assume the responsibilities of a Reviewer.
74+
3. At least two members of the team that owns the repository in question, who are already Maintainers, must concur to merge the PR.
75+
76+
77+
### Maintainer
78+
Description: Maintainers are very established contributors with deep technical knowledge of the Podman project and/or one of its subprojects. Maintainers are granted the authority to merge pull requests, and are expected to participate in making decisions about the strategy and priorities of the project. Maintainers are responsible for code review and merging in a single repository or subproject. It is possible to become Maintainer of additional repositories or subprojects, but each additional repository or project will require a separate application and vote They are able to participate in all maintainer activities, including Core Maintainer meetings, but do not have a vote at Core Maintainer meetings.
79+
80+
In repositories using an OWNERS file, Maintainers are listed as Approvers in that file.
81+
82+
A Maintainer must meet the responsibilities and requirements of a Reviewer, plus:
83+
* Responsibilities include:
84+
* Sustained high level of reviews of pull requests to the project or subproject, with a goal of one or more a week when averaged across the year.
85+
* Merging pull requests which pass review
86+
* Mentoring new Reviewers
87+
* Participating in CNCF maintainer activities for the projects they are maintainers of
88+
* Assisting Core Maintainers in determining strategy and policy for the project
89+
* Participating in, and leading, community meetings
90+
* Requirements
91+
* Experience as a Reviewer for at least 6 months, or status as an Emeritus Maintainer. The time requirement may be overridden by a supermajority vote of Maintainers.
92+
* Demonstrates a broad knowledge of the project or one or more of its subprojects
93+
* Is able to exercise judgment for the good of the project, independent of their employer, friends, or team
94+
* Mentors contributors, reviewers, and new maintainers
95+
* Collaborates with other Maintainers to work on complex contributions
96+
* Can commit to maintaining a high level of contribution to the project or one of its subprojects
97+
* Additional privileges:
98+
* Represent the project in public as a senior project member
99+
* Communicate with the CNCF on behalf of the project
100+
* Have a vote in Maintainer decision-making meetings
101+
102+
#### Process of becoming a maintainer:
103+
1. A current reviewer must be sponsored by a Maintainer of the repository in question. The Maintainer will open a PR against the repository and add the nominee as an Approver in the MAINTAINERS.md file. The need for a sponsor is removed for Emeritus Maintainers, who may open this pull request themselves.
104+
2. The nominee will add a comment to the PR testifying that they agree to all requirements and responsibilities of becoming a Maintainer.
105+
3. A majority of the current Maintainers of the repository or subproject must then approve the PR. The need for a majority is removed for Emeritus Maintainers, who require only 2 current maintainers to approve their return.
106+
107+
#### Community Manager
108+
Some maintainers may also be designated Community Managers. Community managers are responsible for the project’s community interactions, including project social media, website maintenance, gathering metrics, managing the new contributor process, ensuring documentation is easy to use and welcoming to new users, and managing the project’s interactions with the CNCF.
109+
110+
* Responsibilities include:
111+
* All responsibilities of the Maintainer role
112+
* Arranging, participating in, and leading, community meetings
113+
* Managing the project website and gathering associated metrics
114+
* Managing the project’s social media accounts and mailing lists and gathering associated metrics
115+
* Requirements
116+
* All Requirements of the Maintainer role
117+
* Must have already been a Maintainer for at least 3 months
118+
* Collaborates with project maintainers on matters related to the community
119+
* Advocates for the community in Maintainer and Core Maintainer meetings
120+
* Additional privileges:
121+
* All Additional Privileges of the Maintainer role
122+
123+
#### Process of becoming a Community Manager:
124+
1. A current maintainer may nominate themselves as a community manager by a pull request against the main Podman repository’s MAINTAINERS.md file.
125+
2. This nomination is confirmed by a majority vote of the Core Maintainers.
126+
127+
128+
### Core Maintainer
129+
Description: As the Podman project is composed of a number of subprojects, most maintainers will not have full knowledge of the full project and all its technical aspects. Those that do are eligible to become Core Maintainers, responsible for decisions affecting the entire project. Core Maintainers may act as a maintainer in all repositories and subprojects of the Podman Project.
130+
131+
* Responsibilities include:
132+
* All responsibilities of a maintainer
133+
* Determining strategy and policy for the project
134+
* Participating in, and leading, community meetings
135+
* Requirements
136+
* Experience as a Maintainer for at least 3 months
137+
* Demonstrates a broad knowledge of all components, repositories, and subprojects of the Podman project.
138+
* Is able to exercise judgment for the good of the project, independent of their employer, friends, or team
139+
* Mentors new Maintainers and Core Maintainers
140+
* Able to make decisions and contributions affecting the whole project, including multiple subprojects and repositories
141+
* Can commit to maintaining a high level of contribution to the project as a whole
142+
* Additional privileges:
143+
* Represent the project in public as a senior project member
144+
* Communicate with the CNCF on behalf of the project
145+
* Have a vote in Maintainer decision-making meetings
146+
147+
#### Process of becoming a Core Maintainer Member:
148+
1. A current maintainer must be sponsored by Core Maintainer. The Core Maintainer will open a PR against the main Podman repository and add the nominee as a Core Maintainer in the MAINTAINERS.md file.
149+
2. The nominee will add a comment to the PR testifying that they agree to all requirements and responsibilities of becoming a Core Maintainer.
150+
3. A majority of the current Core Maintainers must then approve the PR.
151+
4. If, for some reason, all existing members are inactive according to the Inactivity policy below or there are no Core Maintainers due to resignations, a supermajority vote of maintainers can bypass this process and approve new Core Maintainers directly.
152+
153+
### Emeritus Maintainer
154+
Emeritus Maintainers are former Maintainers or Core Maintainers whose status has lapsed, either voluntarily or through inactivity. We recognize that these former maintainers still have valuable experience and insights, and maintain Emeritus status as a way of recognizing this. Emeritus Maintainer also offers a fast-tracked path to becoming a Maintainer again, should the contributor wish to return to the project.
155+
156+
Emeritus Maintainers have no responsibilities or requirements beyond those of an ordinary Contributor.
157+
158+
#### Process of becoming an Emeritus Maintainer:
159+
1. A current Maintainer or Core Maintainer may voluntarily resign from their position by making a pull request changing their role in the OWNERS file. They may choose to remove themselves entirely or to change their role to Emeritus Maintainer.
160+
2. Maintainers and Core Maintainers removed due to the Inactivity policy below may be moved to Emeritus Status.
161+
162+
## Maintainers File
163+
164+
The definitive source of truth for maintainers of a repository is the MAINTAINERS.md file in that repository. The MAINTAINERS.md file in the main Podman repository is used for project-spanning roles, including Core Maintainer and Community Manager. Some repositories in the project will also have an OWNERS file, used by the CI system to map users to roles. Any changes to the OWNERS file must make a corresponding change to the MAINTAINERS.md file to ensure that file maintains up to date. Most changes to MAINTAINERS.md will require a change to the repository’s OWNERS file (e.g. adding a Reviewer) but some will not (e.g. promoting a Maintainer to a Core Maintainer, which comes with no additional CI-related privileges).
165+
166+
## Inactivity
167+
168+
* Inactivity is measured by one or more of the following:
169+
* Periods of no contribution of code, pull request review, or participation in issue triage for longer than 12 months
170+
* Periods of no communication for longer than 3 months
171+
* Consequences of being inactive include:
172+
* Involuntary removal or demotion
173+
* Being asked to move to Emeritus status
174+
175+
## Involuntary Removal or Demotion
176+
177+
Involuntary removal/demotion of a contributor happens when responsibilities and requirements aren't being met. This may include repeated patterns of inactivity, an 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 opening up opportunities for new contributors to step in.
178+
179+
Involuntary removal or demotion of Maintainers and Reviewers is handled through a vote by a majority of the current Maintainers. Core Maintainers may be involuntarily removed by a majority vote of current Core Maintainers or, if all Core Maintainers have stepped down or are inactive according to the inactivity policy, by a supermajority (66%) vote of maintainers.
180+
181+
## Stepping Down/Emeritus Process
182+
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).
183+
184+
Maintainers and Reviewers should contact the Maintainers about changing to Emeritus status, or reducing your contributor level. Core Maintainers should contact other Core Maintainers.
185+
186+
## Updates to this document
187+
Updates to this Governance document require approval from a majority vote of the Core Maintainers.
188+
189+
## Contact
190+
* For inquiries, please reach out to:
191+
* Tom Sweeney, Community Manager

0 commit comments

Comments
 (0)