Skip to content

Commit 5e415fb

Browse files
committed
*: Use four-space indents for list-entry continuation
The Markdown spec is liberal for the first paragraph [1]: > To make lists look nice, you can wrap items with hanging > indents... But if you want to be lazy, you don’t have to... However, it's a bit more strict about subsequent paragraphs [1]: > List items may consist of multiple paragraphs. Each subsequent > paragraph in a list item must be indented by either 4 spaces or one > tab: That doesn't matter for our use here, because all of our entries are single-paragraph. But runtime-spec has been bitten by Pandoc strictness for multiple paragraphs before [2], and their RELEASES.md has used four-space indents since [3]. By adopting the stricter behavior here, we make it easier for OCI Projects to stay synchronized with the template while maintaining their stricter local conventions. OCI Projects that do not have strict local conventions probably don't care either way. [1]: https://daringfireball.net/projects/markdown/syntax#list [2]: opencontainers/runtime-spec#495 [3]: opencontainers/runtime-spec#846 Signed-off-by: W. Trevor King <[email protected]>
1 parent 61d73a3 commit 5e415fb

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

MAINTAINERS_GUIDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ It is every maintainer's responsibility to:
2525
* Expose a clear roadmap for improving their component.
2626
* Deliver prompt feedback and decisions on pull requests.
2727
* Be available to anyone with questions, bug reports, criticism etc. on their component.
28-
This includes IRC and GitHub issues and pull requests.
28+
This includes IRC and GitHub issues and pull requests.
2929
* Make sure their component respects the philosophy, design and roadmap of the project.
3030

3131
## How are decisions made?
@@ -44,16 +44,16 @@ a change to the philosophy manifesto. And so on.
4444
All decisions affecting this project, big and small, follow the same procedure:
4545

4646
1. Discuss a proposal on the [mailing list](CONTRIBUTING.md#mailing-list).
47-
Anyone can do this.
47+
Anyone can do this.
4848
2. Open a pull request.
49-
Anyone can do this.
49+
Anyone can do this.
5050
3. Discuss the pull request.
51-
Anyone can do this.
51+
Anyone can do this.
5252
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).
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).
5555
5. Merge or close the pull request.
56-
The relevant maintainers do this.
56+
The relevant maintainers do this.
5757

5858
### I'm a maintainer, should I make pull requests too?
5959

RELEASES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ Specifications have a variety of different timelines in their lifecycle.
4343

4444
* Pre-v1.0.0 specifications SHOULD release on a monthly cadence to garner feedback.
4545
* 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.
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.
4949
* Minor and patch releases SHOULD be made on an as-needed basis.
5050

5151
[charter]: https://www.opencontainers.org/about/governance

0 commit comments

Comments
 (0)