Handling release notes for language guarantees made in the Reference
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Recently, in the Reference, we merged https://github.com/rust-lang/reference/pull/2264. This is a new language guarantee, and I'd expect we'd want to document that in the release notes in the same spirit as earlier ones such as:
- Document NaN bit patterns guarantees
- Guarantee layout and ABI of
Resultin some scenarios - Document maximum allocation size
- Document Rust ABI compatibility between various types
I'm not certain about the process for this with the new tooling when this guarantee is made in the Reference rather than in rust-lang/rust. I've added a relnotes label in https://github.com/rust-lang/reference to use for this, if that helps.
@rust-lang/release: Thoughts?
cc @ehuss
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing Reference PR 2264 and the earlier release-note PRs linked in the issue. Then determine how the current release-note tooling handles guarantees documented in the Reference, including whether the relnotes label is part of the process; done means the new guarantee is represented through the agreed release-note workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100