Skip to content

Commit 656a1b1

Browse files
committed
doc: Copyedit stability documentation
This is only to make the information that is already there clearer. It does not attempt to update the information to be more current (nor is this an attempt to advance any kind of policy changes). - Improve consistency in use of code spans and italics. - Have all references to "semver" be the hyperlink. - Fix a minor spelling error. - Very slightly adjust punctuation for clarity and consistency.
1 parent 1744927 commit 656a1b1

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

STABILITY.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,22 @@ Please note that this guide isn't stable itself and may be adjusted to fit chang
1414
- _workspace crate_
1515
- A crate which is a member of this workspace and hence is stored in this repository
1616
- _breaking change_
17-
- A change in code that requires a `dependent crate` to adjust their code to fix compile errors.
17+
- A change in code that requires a _dependent crate_ to adjust their code to fix compile errors.
1818
- _release_
1919
- A new version of a crate is published to crates.io
2020
- _development version_
2121
- A crate version whose _major_ version is 0.
2222
- _release version_
2323
- A crate version whose _major_ version is 1 or higher.
2424
- _initial development phase_ (IDP)
25-
- The phase of development leading up to producing a crate with a major version of 1 or greater, as per `semver`.
25+
- The phase of development leading up to producing a crate with a major version of 1 or greater, as per [semver].
2626
- Not to be confused with the term _pre-release_, which is used to indicate any release version prior to an actual release, like `1.1.0-beta.1`.
2727

2828
## Tiers
2929

3030
The project uses three stability tiers for all of its crates, and all crates use [semver] for their version numbers.
31-
Tiers differ primarily in the time between breaking changes, which always have to be announced with `PRs` as per
31+
32+
Tiers differ primarily in the time between breaking changes, which always have to be announced with *PRs* as per
3233
our [collaboration guide].
3334

3435
The following schematic helps to visualize what follows.
@@ -108,10 +109,10 @@ If there are additional breaking changes without a release, these push back the
108109
### Tier 1: released apps and application crates
109110

110111
Released apps and application crates are marked with major version number 1 or above, like `2.3.0+21.06` and live in tier 1 _(->ST1)_,
111-
with the build identifiers for year (`21`) and month `06` appended, based on the actual release year and month.
112+
with the build identifiers for year (`21`) and month (`06`) appended, based on the actual release year and month.
112113

113114
Breaking changes are collected and may be released no more often than every 6 months by incrementing the major version number. If there are additional breaking changes,
114-
these push bac the release date so that they can be tested at least for 3 months. For example, a breaking change happens in January 01, and another breaking change in February 15.
115+
these push back the release date so that they can be tested at least for 3 months. For example, a breaking change happens in January 01, and another breaking change in February 15.
115116
The earliest release date is July 1st. Had the second breaking change happened in April 01, the release date would have to be pushed to August 1st.
116117

117118
Intermediate pre-releases may be created at most every 4 weeks by appending `-alpha.X` where `X` is the sequential release number. These should help testing

0 commit comments

Comments
 (0)