Skip to content

Commit a65fab6

Browse files
committed
Merge branch 'master' of git://github.com/opencontainers/project-template into merge-project-template
To fulfill the TOB's [1]: Both of the proposed projects would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template. which was approved with this vote [2]. Generated with: $ git pull git://github.com/opencontainers/project-template.git master $ git checkout --ours .pullapprove.yml README.md $ git checkout --theirs CONTRIBUTING.md LICENSE MAINTAINERS_GUIDE.md $ git add .pullapprove.yml CONTRIBUTING.md LICENSE MAINTAINERS_GUIDE.md README.md $ git commit I think there are a few improvements we could make to these template docs [3,4,5], but the TOB vote happened before I'd floated those. If/when they land, we can pull the updated versions into this repository via a follow-up merge. * 'master' of git://github.com/opencontainers/project-template: (33 commits) .pullapprove.yml: Reset on push, ignore authors, and require sign-offs GOVERNANCE.md: fix typo GOVERNANCE and RELEASES: split the files project-governance: Make voting more generic proposals: release approval process explain security@ email proposal: fix a typo proposals: release-approval-process fix a grammar thing release-approval: Add non-spec unanimous quorum reduction release-approval: Shuffle to make more DRY proposals: release-approval-process: fixup additional typos proposals: release approval process: improve REJECT feedback proposals: release approval process: add information to projects proposals: release approval process: add language about mailing list proposals: release approval process: add quorum language proposals: release-approval-process: add voting members language proposals: release approval process: clarify utility of GitHub proposals: release approval process: use consistent language for rejects proposals: release approval process: one month pre-releases proposals: release approval process 3 rcs required proposals: release approval process to one week for apps ... Conflicts: .pullapprove.yml CONTRIBUTING.md LICENSE MAINTAINERS_GUIDE.md README.md [1]: https://github.com/opencontainers/tob/blob/8997b1aa221b3b61d4305bede41c257b879bdeeb/proposals/tools.md#governance-and-releases [2]: https://groups.google.com/a/opencontainers.org/forum/#!topic/tob/rZ4luMa-pxY Subject: VOTE Required: approve new projects: image-tools, runtime-tools Date: Wed, 07 Sep 2016 22:37:32 +0000 Message-ID: <CAD2oYtMLMFQouEVU7HTO-EKnW6vKu82dGT+0mziXZzCyqngj=A@mail.gmail.com> [3]: opencontainers/project-template#18 Subject: GOVERNANCE: Proposing a motion is a LGTM by default [4]: opencontainers/project-template#19 Subject: GOVERNANCE: Drop the co-sponsor requirement [5]: opencontainers/project-template#20 Subject: MAINTAINERS_GUIDE|CONTRIBUTING: Make generic enough for all OCI Projects
2 parents 476f1fb + 3eec2a6 commit a65fab6

File tree

5 files changed

+165
-32
lines changed

5 files changed

+165
-32
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ Fork the repo and make changes on your fork in a feature branch:
2424
- If it's a feature branch, create an enhancement issue to announce your
2525
intentions, and name it XXX-something where XXX is the number of the issue.
2626

27-
Submit unit tests for your changes. Go has a great test framework built in; use
28-
it! Take a look at existing tests for inspiration. Run the full test suite on
29-
your branch before submitting a pull request.
27+
Small changes or changes that have been discussed on the project mailing list
28+
may be submitted without a leader issue, in which case you are free to name
29+
your branch however you like.
30+
31+
If the project has a test suite, submit unit tests for your changes. Take a
32+
look at existing tests for inspiration. Run the full test suite on your branch
33+
before submitting a pull request.
3034

3135
Update the documentation when creating or modifying features. Test
3236
your documentation changes for clarity, concision, and correctness, as
@@ -40,10 +44,8 @@ committing your changes. Most editors have plugins that do this automatically.
4044
Pull requests descriptions should be as clear as possible and include a
4145
reference to all the issues that they address.
4246

43-
Pull requests must not contain commits from other users or branches.
44-
45-
Commit messages must start with a capitalized and short summary (max. 50
46-
chars) written in the imperative, followed by an optional, more detailed
47+
Commit messages must start with a capitalized and short summary
48+
written in the imperative, followed by an optional, more detailed
4749
explanatory text which is separated from the summary by an empty line.
4850

4951
Code review comments may be added to your pull request. Discuss, then make the
@@ -54,8 +56,9 @@ comment.
5456

5557
Before the pull request is merged, make sure that you squash your commits into
5658
logical units of work using `git rebase -i` and `git push -f`. After every
57-
commit the test suite should be passing. Include documentation changes in the
58-
same commit so that a revert would remove all traces of the feature or fix.
59+
commit the test suite (if any) should be passing. Include documentation changes
60+
in the same commit so that a revert would remove all traces of the feature or
61+
fix.
5962

6063
Commits that fix or close an issue should include a reference like `Closes #XXX`
6164
or `Fixes #XXX`, which will automatically close the issue when merged.

GOVERNANCE.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Project governance
2+
3+
The [OCI charter][charter] §5.b.viii tasks an OCI Project's maintainers (listed in the repository's MAINTAINERS file and sometimes referred to as "the TDC", [§5.e][charter]) with:
4+
5+
> Creating, maintaining and enforcing governance guidelines for the TDC, approved by the maintainers, and which shall be posted visibly for the TDC.
6+
7+
This section describes generic rules and procedures for fulfilling that mandate.
8+
9+
## Proposing a motion
10+
11+
A maintainer SHOULD propose a motion on the [email protected] mailing list (except [security issues](#security-issues)) with another maintainer as a co-sponsor.
12+
13+
## Voting
14+
15+
Voting on a proposed motion SHOULD happen on the [email protected] mailing list (except [security issues](#security-issues)) with maintainers posting LGTM or REJECT.
16+
Maintainers MAY also explicitly not vote by posting ABSTAIN (which is useful to revert a previous vote).
17+
Maintainers MAY post multiple times (e.g. as they revise their position based on feeback), but only their final post counts in the tally.
18+
A proposed motion is adopted if two-thirds of votes cast, a quorum having voted, are in favor of the release.
19+
20+
Voting SHOULD remain open for a week to collect feedback from the wider community and allow the maintainers to digest the proposed motion.
21+
Under exceptional conditions (e.g. non-major security fix releases) proposals which reach quorum with unanimous support MAY be adopted earlier.
22+
23+
A maintainer MAY choose to reply with REJECT.
24+
A maintainer posting a REJECT MUST include a list of concerns or links to written documentation for those concerns (e.g. GitHub issues or mailing-list threads).
25+
The maintainers SHOULD try to resolve the concerns and wait for the rejecting maintainer to change their opinion to LGTM.
26+
However, a motion MAY be adopted with REJECTs, as outlined in the previous paragraphs.
27+
28+
## Quorum
29+
30+
A quorum is established when at least two-thirds of maintainers have voted.
31+
32+
For projects that are not specifications, a [motion to release](#release-approval) MAY be adopted if the tally is at least three LGTMs and no REJECTs, even if three votes does not meet the usual two-thirds quorum.
33+
34+
## Security issues
35+
36+
Motions with sensitive security implications MUST be proposed on the [email protected] mailing list instead of [email protected], but should otherwise follow the standard [proposal](#proposing-a-motion) process.
37+
The [email protected] mailing list includes all members of the TOB.
38+
The TOB will contact the project maintainers and provide a channel for discussing and voting on the motion, but voting will otherwise follow the standard [voting](#voting) and [quorum](#quorum) rules.
39+
The TOB and project maintainers will work together to notify affected parties before making an adopted motion public.
40+
41+
## Amendments
42+
43+
The [project governance](#project-governance) rules and procedures MAY be amended or replaced using the procedures themselves.
44+
The MAINTAINERS of this project governance document is the total set of MAINTAINERS from all Open Containers projects (runC, runtime-spec, and image-spec).
45+
46+
## Subject templates
47+
48+
Maintainers are busy and get lots of email.
49+
To make project proposals recognizable, proposed motions SHOULD use the following subject templates.
50+
51+
### Proposing a motion
52+
53+
> [{project} VOTE]: {motion description} (closes {end of voting window})
54+
55+
For example:
56+
57+
> [runtime-spec VOTE]: Tag 0647920 as 1.0.0-rc (closes 2016-06-03 20:00 UTC)
58+
59+
### Tallying results
60+
61+
After voting closes, a maintainer SHOULD post a tally to the motion thread with a subject template like:
62+
63+
> [{project} {status}]: {motion description} (+{LGTMs} -{REJECTs} #{ABSTAINs})
64+
65+
Where `{status}` is either `adopted` or `rejected`.
66+
For example:
67+
68+
> [runtime-spec adopted]: Tag 0647920 as 1.0.0-rc (+6 -0 #3)
69+
70+
[charter]: https://www.opencontainers.org/about/governance

LICENSE

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Apache License
32
Version 2.0, January 2004
43
http://www.apache.org/licenses/
@@ -176,7 +175,18 @@
176175

177176
END OF TERMS AND CONDITIONS
178177

179-
Copyright 2015 The Linux Foundation.
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
180190

181191
Licensed under the Apache License, Version 2.0 (the "License");
182192
you may not use this file except in compliance with the License.

MAINTAINERS_GUIDE.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ All decisions affecting this project, big and small, follow the same 3 steps:
5050

5151
* Step 2: Discuss the pull request. Anyone can do this.
5252

53-
* Step 3: Accept (`LGTM`) or refuse a pull request. The relevant maintainers do
53+
* Step 3: Accept (`LGTM`) or refuse a pull request. The relevant maintainers do
5454
this (see below "Who decides what?")
5555

5656
### I'm a maintainer, should I make pull requests too?
@@ -62,43 +62,45 @@ made through a pull request.
6262

6363
All decisions are pull requests, and the relevant maintainers make
6464
decisions by accepting or refusing the pull request. Review and acceptance
65-
by anyone is denoted by adding a comment in the pull request: `LGTM`.
65+
by anyone is denoted by adding a comment in the pull request: `LGTM`.
6666
However, only currently listed `MAINTAINERS` are counted towards the required
67-
two LGTMs.
67+
two LGTMs. In addition, if a maintainer has created a pull request, they cannot
68+
count toward the two LGTM rule (to ensure equal amounts of review for every pull
69+
request, no matter who wrote it).
6870

6971
Overall the maintainer system works because of mutual respect across the
7072
maintainers of the project. The maintainers trust one another to make decisions
71-
in the best interests of the project. Sometimes maintainers can disagree and
73+
in the best interests of the project. Sometimes maintainers can disagree and
7274
this is part of a healthy project to represent the point of views of various people.
73-
In the case where maintainers cannot find agreement on a specific change the
74-
role of a Chief Maintainer comes into play.
75+
In the case where maintainers cannot find agreement on a specific change the
76+
role of a Chief Maintainer comes into play.
7577

76-
The Chief Maintainer for the project is responsible for overall architecture
77-
of the project to maintain conceptual integrity. Large decisions and
78-
architecture changes should be reviewed by the chief maintainer.
79-
The current chief maintainer for the project is the first person listed
80-
in the MAINTAINERS file.
78+
The Chief Maintainer for the project is responsible for overall architecture
79+
of the project to maintain conceptual integrity. Large decisions and
80+
architecture changes should be reviewed by the chief maintainer.
81+
The current chief maintainer for the project is the first person listed
82+
in the MAINTAINERS file.
8183

8284
Even though the maintainer system is built on trust, if there is a conflict
83-
with the chief maintainer on a decision, their decision can be challenged
84-
and brought to the technical oversight board if two-thirds of the
85-
maintainers vote for an appeal. It is expected that this would be a
85+
with the chief maintainer on a decision, their decision can be challenged
86+
and brought to the technical oversight board if two-thirds of the
87+
maintainers vote for an appeal. It is expected that this would be a
8688
very exceptional event.
8789

8890

8991
### How are maintainers added?
9092

9193
The best maintainers have a vested interest in the project. Maintainers
9294
are first and foremost contributors that have shown they are committed to
93-
the long term success of the project. Contributors wanting to become
94-
maintainers are expected to be deeply involved in contributing code,
95+
the long term success of the project. Contributors wanting to become
96+
maintainers are expected to be deeply involved in contributing code,
9597
pull request review, and triage of issues in the project for more than two months.
9698

97-
Just contributing does not make you a maintainer, it is about building trust
99+
Just contributing does not make you a maintainer, it is about building trust
98100
with the current maintainers of the project and being a person that they can
99101
depend on and trust to make decisions in the best interest of the project. The
100102
final vote to add a new maintainer should be approved by over 66% of the current
101-
maintainers with the chief maintainer having veto power. In case of a veto,
103+
maintainers with the chief maintainer having veto power. In case of a veto,
102104
conflict resolution rules expressed above apply. The voting period is
103105
five business days on the Pull Request to add the new maintainer.
104106

@@ -116,6 +118,3 @@ a vote by 66% of the current maintainers with the chief maintainer having veto p
116118
The voting period is ten business days. Issues related to a maintainer's performance should
117119
be discussed with them among the other maintainers so that they are not surprised by
118120
a pull request removing them.
119-
120-
121-

RELEASES.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Releases
2+
3+
The release process hopes to encourage early, consistent consensus-building during project development.
4+
The mechanisms used are regular community communication on the mailing list about progress, scheduled meetings for issue resolution and release triage, and regularly paced and communicated releases.
5+
Releases are proposed and adopted or rejected using the usual [project governance](GOVERNANCE.md) rules and procedures.
6+
7+
An anti-pattern that we want to avoid is heavy development or discussions "late cycle" around major releases.
8+
We want to build a community that is involved and communicates consistently through all releases instead of relying on "silent periods" as a judge of stability.
9+
10+
## Parallel releases
11+
12+
A single project MAY consider several motions to release in parallel.
13+
However each motion to release after the initial 0.1.0 MUST be based on a previous release that has already landed.
14+
15+
For example, runtime-spec maintainers may propose a v1.0.0-rc2 on the 1st of the month and a v0.9.1 bugfix on the 2nd of the month.
16+
They may not propose a v1.0.0-rc3 until the v1.0.0-rc2 is accepted (on the 7th if the vote initiated on the 1st passes).
17+
18+
## Specifications
19+
20+
The OCI maintains three categories of projects: specifications, applications, and conformance-testing tools.
21+
However, specification releases have special restrictions in the [OCI charter][charter]:
22+
23+
* They are the target of backwards compatibility (§7.g), and
24+
* They are subject to the OFWa patent grant (§8.d and e).
25+
26+
To avoid unfortunate side effects (onerous backwards compatibity requirements or Member resignations), the following additional procedures apply to specification releases:
27+
28+
### Planning a release
29+
30+
Every OCI specification project SHOULD hold meetings that involve maintainers reviewing pull requests, debating outstanding issues, and planning releases.
31+
This meeting MUST be advertised on the project README and MAY happen on a phone call, video conference, or on IRC.
32+
Maintainers MUST send updates to the [email protected] with results of these meetings.
33+
34+
Before the specification reaches v1.0.0, the meetings SHOULD be weekly.
35+
Once a specification has reached v1.0.0, the maintainers may alter the cadence, but a meeting MUST be held within four weeks of the previous meeting.
36+
37+
The release plans, corresponding milestones and estimated due dates MUST be published on GitHub (e.g. https://github.com/opencontainers/runtime-spec/milestones).
38+
GitHub milestones and issues are only used for community organization and all releases MUST follow the [project governance](GOVERNANCE.md) rules and procedures.
39+
40+
### Timelines
41+
42+
Specifications have a variety of different timelines in their lifecycle.
43+
44+
* Pre-v1.0.0 specifications SHOULD release on a monthly cadence to garner feedback.
45+
* Major specification releases MUST release at least three release candidates spaced a minimum of one week apart.
46+
This means a major release like a v1.0.0 or v2.0.0 release will take 1 month at minimum: one week for rc1, one week for rc2, one week for rc3, and one week for the major release itself.
47+
Maintainers SHOULD strive to make zero breaking changes during this cycle of release candidates and SHOULD restart the three-candidate count when a breaking change is introduced.
48+
For example if a breaking change is introduced in v1.0.0-rc2 then the series would end with v1.0.0-rc4 and v1.0.0.
49+
- Minor and patch releases SHOULD be made on an as-needed basis.
50+
51+
[charter]: https://www.opencontainers.org/about/governance

0 commit comments

Comments
 (0)