Skip to content

Commit 830cfc0

Browse files
matkladlunacookies
andauthored
Apply suggestions from code review
Co-authored-by: Aramis Razzaghipour <[email protected]>
1 parent f2acecc commit 830cfc0

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

src/checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
- **Necessities** *(to whom they matter, they really matter)*
7373
- [ ] Public dependencies of a stable crate are stable ([C-STABLE])
7474
- [ ] Crate and its dependencies have a permissive license ([C-PERMISSIVE])
75-
- [ ] Crate has MSRV policy ([C-MSRV])
75+
- [ ] Crate has an MSRV policy ([C-MSRV])
7676

7777

7878
[C-CASE]: naming.html#c-case

src/necessities.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,21 +111,21 @@ distribution of the crate itself, so a permissively-licensed crate should
111111
generally only depend on permissively-licensed crates.
112112

113113
<a id="c-msrv"></a>
114-
## Crate has a MSRV policy (C-MSRV)
114+
## Crate has an MSRV policy (C-MSRV)
115115

116116
A crate should clearly document its Minimal Supported Rust Version:
117117

118118
* Which versions versions of Rust are supported now?
119119
* Under what conditions is MSRV increased?
120-
* How MSRV increases are reflected in the semver version of the crate?
120+
* How are MSRV increases reflected in the semver version of the crate?
121121

122-
MSRV should be tested in CI.
122+
Compliance with a crate’s stated MSRV should be tested in CI.
123123

124-
The API guidelines tentatively suggest that, for libraries, MSRV increase should
124+
The API guidelines tentatively suggest that, for libraries, an MSRV increase should
125125
*not* be considered a semver-breaking change. Specifically, when increasing
126126
MSRV:
127127

128-
* for crates past `1.0.0` increment minor version (`1.1.3` -> `1.2.0`),
128+
* for crates past `1.0.0`, increment minor version (`1.1.3` -> `1.2.0`),
129129
* for crates before `1.0.0`, increment patch version (`0.1.3` -> `0.1.4`).
130130

131131
This reduces the amount of ecosystem-wide work for MSRV upgrades and prevents
@@ -135,13 +135,13 @@ combinations of library and compiler versions, at the cost of breaking `cargo
135135
update` workflow for older compilers.
136136

137137
However, do not increase MSRV without a good reason, and, if possible, batch
138-
MSRV increases with sevmer-breaking changes.
138+
MSRV increases with semver-breaking changes.
139139

140-
Nonetheless, some crates intentionally choose to treat MSRV increase as a semver
140+
Nonetheless, some crates intentionally choose to treat MSRV increases as a semver
141141
breaking change. This is also a valid strategy, but it is not recommended as the
142142
default choice.
143143

144-
To reliably test MSRV on CI, use a dedicated Cargo.lock file with dependencies
144+
To reliably test MSRV on CI, use a dedicated `Cargo.lock` file with dependencies
145145
pinned to minimal versions:
146146

147147
```bash

0 commit comments

Comments
 (0)