Skip to content

Commit d7176fd

Browse files
committed
MAINTAINERS_GUIDE: Mention email in "How are decisions made?"
The old wording did not mention email discussion before working up changes, which we often recommend [1,2] to avoid contributors sinking a lot of work into a pull request that ends up being rejected because of a fundamental design issue. The new wording mentions that and also: * Removes the overly compact short answer to avoid confusion [3]. The section is not so long that it needs a one-line summary. * Distinguishes between in-PR votes (LGTM/Rejected) and merging/closing the PR. * Mentions GOVERNANCE for management changes. * Uses an enumerated list instead of "Step N" text. * Uses one line per sentence. [1]: CONTRIBUTING.md#conventions [2]: opencontainers/runtime-spec#420 (comment) [3]: opencontainers/runtime-spec#420 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 62bcb78 commit d7176fd

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

MAINTAINERS_GUIDE.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ It is every maintainer's responsibility to:
3030

3131
## How are decisions made?
3232

33-
Short answer: with pull requests to the project repository.
34-
3533
This project is an open-source project with an open design philosophy. This
3634
means that the repository is the source of truth for EVERY aspect of the
3735
project, including its philosophy, design, roadmap and APIs. *If it's
@@ -43,14 +41,19 @@ repository. An implementation change is a change to the source code. An
4341
API change is a change to the API specification. A philosophy change is
4442
a change to the philosophy manifesto. And so on.
4543

46-
All decisions affecting this project, big and small, follow the same 3 steps:
47-
48-
* Step 1: Open a pull request. Anyone can do this.
49-
50-
* Step 2: Discuss the pull request. Anyone can do this.
51-
52-
* Step 3: Accept (`LGTM`) or refuse a pull request. The relevant maintainers do
53-
this (see below "Who decides what?")
44+
All decisions affecting this project, big and small, follow the same procedure:
45+
46+
1. Discuss a proposal on the [mailing list](CONTRIBUTING.md#mailing-list).
47+
Anyone can do this.
48+
2. Open a pull request.
49+
Anyone can do this.
50+
3. Discuss the pull request.
51+
Anyone can do this.
52+
4. Endorse (`LGTM`) or oppose (`Rejected`) the pull request.
53+
The relevant maintainers do this (see below [Who decides what?](#who-decides-what)).
54+
Changes that affect project management (changing policy, cutting releases, etc.) are [proposed and voted on the mailing list](GOVERNANCE.md).
55+
5. Merge or close the pull request.
56+
The relevant maintainers do this.
5457

5558
### I'm a maintainer, should I make pull requests too?
5659

0 commit comments

Comments
 (0)