| 1 |
# Distribution maintainers file |
| 2 |
# |
| 3 |
# This file describes who runs the docker/distribution project and how. |
| 4 |
# This is a living document - if you see something out of date or missing, speak up! |
| 5 |
# |
| 6 |
# It is structured to be consumable by both humans and programs. |
| 7 |
# To extract its contents programmatically, use any TOML-compliant parser. |
| 8 |
# |
| 9 |
|
| 10 |
[Rules] |
| 11 |
|
| 12 |
[Rules.maintainers] |
| 13 |
|
| 14 |
title = "What is a maintainer?" |
| 15 |
|
| 16 |
text = """ |
| 17 |
There are different types of maintainers, with different responsibilities, but |
| 18 |
all maintainers have 3 things in common: |
| 19 |
|
| 20 |
1) They share responsibility in the project's success. |
| 21 |
2) They have made a long-term, recurring time investment to improve the project. |
| 22 |
3) They spend that time doing whatever needs to be done, not necessarily what |
| 23 |
is the most interesting or fun. |
| 24 |
|
| 25 |
Maintainers are often under-appreciated, because their work is harder to appreciate. |
| 26 |
It's easy to appreciate a really cool and technically advanced feature. It's harder |
| 27 |
to appreciate the absence of bugs, the slow but steady improvement in stability, |
| 28 |
or the reliability of a release process. But those things distinguish a good |
| 29 |
project from a great one. |
| 30 |
""" |
| 31 |
|
| 32 |
[Rules.reviewer] |
| 33 |
|
| 34 |
title = "What is a reviewer?" |
| 35 |
|
| 36 |
text = """ |
| 37 |
A reviewer is a core role within the project. |
| 38 |
They share in reviewing issues and pull requests and their LGTM count towards the |
| 39 |
required LGTM count to merge a code change into the project. |
| 40 |
|
| 41 |
Reviewers are part of the organization but do not have write access. |
| 42 |
Becoming a reviewer is a core aspect in the journey to becoming a maintainer. |
| 43 |
""" |
| 44 |
|
| 45 |
[Rules.adding-maintainers] |
| 46 |
|
| 47 |
title = "How are maintainers added?" |
| 48 |
|
| 49 |
text = """ |
| 50 |
Maintainers are first and foremost contributors that have shown they are |
| 51 |
committed to the long term success of a project. Contributors wanting to become |
| 52 |
maintainers are expected to be deeply involved in contributing code, pull |
| 53 |
request review, and triage of issues in the project for more than three months. |
| 54 |
|
| 55 |
Just contributing does not make you a maintainer, it is about building trust |
| 56 |
with the current maintainers of the project and being a person that they can |
| 57 |
depend on and trust to make decisions in the best interest of the project. |
| 58 |
|
| 59 |
Periodically, the existing maintainers curate a list of contributors that have |
| 60 |
shown regular activity on the project over the prior months. From this list, |
| 61 |
maintainer candidates are selected and proposed on the maintainers mailing list. |
| 62 |
|
| 63 |
After a candidate has been announced on the maintainers mailing list, the |
| 64 |
existing maintainers are given five business days to discuss the candidate, |
| 65 |
raise objections and cast their vote. Candidates must be approved by at least 66% of the current maintainers by adding their vote on the mailing |
| 66 |
list. Only maintainers of the repository that the candidate is proposed for are |
| 67 |
allowed to vote. |
| 68 |
|
| 69 |
If a candidate is approved, a maintainer will contact the candidate to invite |
| 70 |
the candidate to open a pull request that adds the contributor to the |
| 71 |
MAINTAINERS file. The candidate becomes a maintainer once the pull request is |
| 72 |
merged. |
| 73 |
""" |
| 74 |
|
| 75 |
[Rules.stepping-down-policy] |
| 76 |
|
| 77 |
title = "Stepping down policy" |
| 78 |
|
| 79 |
text = """ |
| 80 |
Life priorities, interests, and passions can change. If you're a maintainer but |
| 81 |
feel you must remove yourself from the list, inform other maintainers that you |
| 82 |
intend to step down, and if possible, help find someone to pick up your work. |
| 83 |
At the very least, ensure your work can be continued where you left off. |
| 84 |
|
| 85 |
After you've informed other maintainers, create a pull request to remove |
| 86 |
yourself from the MAINTAINERS file. |
| 87 |
""" |
| 88 |
|
| 89 |
[Rules.inactive-maintainers] |
| 90 |
|
| 91 |
title = "Removal of inactive maintainers" |
| 92 |
|
| 93 |
text = """ |
| 94 |
Similar to the procedure for adding new maintainers, existing maintainers can |
| 95 |
be removed from the list if they do not show significant activity on the |
| 96 |
project. Periodically, the maintainers review the list of maintainers and their |
| 97 |
activity over the last three months. |
| 98 |
|
| 99 |
If a maintainer has shown insufficient activity over this period, a neutral |
| 100 |
person will contact the maintainer to ask if they want to continue being |
| 101 |
a maintainer. If the maintainer decides to step down as a maintainer, they |
| 102 |
open a pull request to be removed from the MAINTAINERS file. |
| 103 |
|
| 104 |
If the maintainer wants to remain a maintainer, but is unable to perform the |
| 105 |
required duties they can be removed with a vote of at least 66% of |
| 106 |
the current maintainers. An e-mail is sent to the |
| 107 |
mailing list, inviting maintainers of the project to vote. The voting period is |
| 108 |
five business days. Issues related to a maintainer's performance should be |
| 109 |
discussed with them among the other maintainers so that they are not surprised |
| 110 |
by a pull request removing them. |
| 111 |
""" |
| 112 |
|
| 113 |
[Rules.decisions] |
| 114 |
|
| 115 |
title = "How are decisions made?" |
| 116 |
|
| 117 |
text = """ |
| 118 |
Short answer: EVERYTHING IS A PULL REQUEST. |
| 119 |
|
| 120 |
distribution is an open-source project with an open design philosophy. This means |
| 121 |
that the repository is the source of truth for EVERY aspect of the project, |
| 122 |
including its philosophy, design, road map, and APIs. *If it's part of the |
| 123 |
project, it's in the repo. If it's in the repo, it's part of the project.* |
| 124 |
|
| 125 |
As a result, all decisions can be expressed as changes to the repository. An |
| 126 |
implementation change is a change to the source code. An API change is a change |
| 127 |
to the API specification. A philosophy change is a change to the philosophy |
| 128 |
manifesto, and so on. |
| 129 |
|
| 130 |
All decisions affecting distribution, big and small, follow the same 3 steps: |
| 131 |
|
| 132 |
* Step 1: Open a pull request. Anyone can do this. |
| 133 |
|
| 134 |
* Step 2: Discuss the pull request. Anyone can do this. |
| 135 |
|
| 136 |
* Step 3: Merge or refuse the pull request. Who does this depends on the nature |
| 137 |
of the pull request and which areas of the project it affects. |
| 138 |
""" |
| 139 |
|
| 140 |
[Rules.DCO] |
| 141 |
|
| 142 |
title = "Helping contributors with the DCO" |
| 143 |
|
| 144 |
text = """ |
| 145 |
The [DCO or `Sign your work`]( |
| 146 |
https://github.com/moby/moby/blob/master/CONTRIBUTING.md#sign-your-work) |
| 147 |
requirement is not intended as a roadblock or speed bump. |
| 148 |
|
| 149 |
Some distribution contributors are not as familiar with `git`, or have used a web |
| 150 |
based editor, and thus asking them to `git commit --amend -s` is not the best |
| 151 |
way forward. |
| 152 |
|
| 153 |
In this case, maintainers can update the commits based on clause (c) of the DCO. |
| 154 |
The most trivial way for a contributor to allow the maintainer to do this, is to |
| 155 |
add a DCO signature in a pull requests's comment, or a maintainer can simply |
| 156 |
note that the change is sufficiently trivial that it does not substantially |
| 157 |
change the existing contribution - i.e., a spelling change. |
| 158 |
|
| 159 |
When you add someone's DCO, please also add your own to keep a log. |
| 160 |
""" |
| 161 |
|
| 162 |
[Rules."no direct push"] |
| 163 |
|
| 164 |
title = "I'm a maintainer. Should I make pull requests too?" |
| 165 |
|
| 166 |
text = """ |
| 167 |
Yes. Nobody should ever push to master directly. All changes should be |
| 168 |
made through a pull request. |
| 169 |
""" |
| 170 |
|
| 171 |
[Rules.tsc] |
| 172 |
|
| 173 |
title = "Conflict Resolution and technical disputes" |
| 174 |
|
| 175 |
text = """ |
| 176 |
distribution defers to the [Technical Steering Committee](https://github.com/moby/tsc) for escalations and resolution on disputes for technical matters." |
| 177 |
""" |
| 178 |
|
| 179 |
[Rules.meta] |
| 180 |
|
| 181 |
title = "How is this process changed?" |
| 182 |
|
| 183 |
text = "Just like everything else: by making a pull request :)" |
| 184 |
|
| 185 |
# Current project organization |
| 186 |
[Org] |
| 187 |
|
| 188 |
[Org.Maintainers] |
| 189 |
people = [ |
| 190 |
"dmcgowan", |
| 191 |
"dmp42", |
| 192 |
"stevvooe", |
| 193 |
] |
| 194 |
[Org.Reviewers] |
| 195 |
people = [ |
| 196 |
"manishtomar", |
| 197 |
"caervs", |
| 198 |
"davidswu", |
| 199 |
"RobbKistler" |
| 200 |
] |
| 201 |
|
| 202 |
[people] |
| 203 |
|
| 204 |
# A reference list of all people associated with the project. |
| 205 |
# All other sections should refer to people by their canonical key |
| 206 |
# in the people section. |
| 207 |
|
| 208 |
# ADD YOURSELF HERE IN ALPHABETICAL ORDER |
| 209 |
|
| 210 |
[people.caervs] |
| 211 |
Name = "Ryan Abrams" |
| 212 |
Email = "[email protected]" |
| 213 |
GitHub = "caervs" |
| 214 |
|
| 215 |
[people.davidswu] |
| 216 |
Name = "David Wu" |
| 217 |
Email = "[email protected]" |
| 218 |
GitHub = "davidswu" |
| 219 |
|
| 220 |
[people.dmcgowan] |
| 221 |
Name = "Derek McGowan" |
| 222 |
Email = "[email protected]" |
| 223 |
GitHub = "dmcgowan" |
| 224 |
|
| 225 |
[people.dmp42] |
| 226 |
Name = "Olivier Gambier" |
| 227 |
Email = "[email protected]" |
| 228 |
GitHub = "dmp42" |
| 229 |
|
| 230 |
[people.manishtomar] |
| 231 |
Name = "Manish Tomar" |
| 232 |
Email = "[email protected]" |
| 233 |
GitHub = "manishtomar" |
| 234 |
|
| 235 |
[people.RobbKistler] |
| 236 |
Name = "Robb Kistler" |
| 237 |
Email = "[email protected]" |
| 238 |
GitHub = "RobbKistler" |
| 239 |
|
| 240 |
[people.stevvooe] |
| 241 |
Name = "Stephen Day" |
| 242 |
Email = "[email protected]" |
| 243 |
GitHub = "stevvooe" |