You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*: 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]>
Copy file name to clipboardExpand all lines: RELEASES.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,9 +43,9 @@ Specifications have a variety of different timelines in their lifecycle.
43
43
44
44
* Pre-v1.0.0 specifications SHOULD release on a monthly cadence to garner feedback.
45
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.
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
49
* Minor and patch releases SHOULD be made on an as-needed basis.
0 commit comments