rust-lang / rust-lang/rustc-dev-guide
It's not clear what's worthy of relnotes
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
Not everything that should go in relnotes is flagged with the relnotes label. This is partly because it's not clear what is worth flagging with relnotes. I certainly have spent almost zero time thinking about whether I should be tagging things with relnotes, regardless of how impactful a change might be.
The dev guide mentions the relnotes label and what it means but doesn't explain how to decide when to assign it.
Contributor guide
No contributing guide indexed for this repository
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 with the issue-triage section of the Rust compiler dev guide linked in the report, including its existing explanation of the relnotes label. Review nearby contribution guidance and recent relnotes-labeled issues to identify the missing decision criteria; done means the guide clearly explains when maintainers should apply the label.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100