Skip to content

Commit f1d662c

Browse files
docs: add MSRV update instructions to copilot guide
Co-authored-by: samueltardieu <44656+samueltardieu@users.noreply.github.com>
1 parent ae249f3 commit f1d662c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.github/copilot-instructions.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,20 @@
166166
3. **codspeed.yml** (Runs on main branch pushes and PRs):
167167
- Runs performance benchmarks
168168

169+
## MSRV (Minimum Supported Rust Version)
170+
171+
When updating the MSRV, you must update it in the following locations:
172+
1. **Cargo.toml** - The `rust-version` field (line 14)
173+
2. **src/lib.rs** - Documentation comment stating "The minimum supported Rust version (MSRV) is Rust X.Y.Z" (line 89)
174+
3. **.github/copilot-instructions.md** - Three locations:
175+
- "MSRV: X.Y.Z" in Key Facts section (line 9)
176+
- "MSRV X.Y.Z" in Prerequisites section (line 18)
177+
- "rust-version = X.Y.Z" in Root Directory Files section (line 102)
178+
179+
**Note:** The GitHub Actions workflow (.github/workflows/tests.yml) automatically reads the MSRV from Cargo.toml, so it does not need manual updates.
180+
181+
After updating the MSRV, always run `sh tests/check-msrv-consistency.sh` to verify that Cargo.toml and src/lib.rs are in sync.
182+
169183
## Critical Validation Rules
170184

171185
### Before Committing

0 commit comments

Comments
 (0)