rust-lang / rust-lang/rust

Include Stabilization version in the tracking issue template

Open
#134,990 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs A-meta C-enhancement
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Location
  • Tracking issues
  • RFCs
  • Stabilization Issues
  • Unstable book
  • Compiler error messages
Summary

In a CI build against my crate's declared MSRV, I get this build failure:

error[E0658]: lint reasons are experimental
  --> webfinger-rs/src/types/rel.rs:6:1
   |
6  | / #[nutype(derive(
7  | |     Debug,
8  | |     Display,
9  | |     Clone,
...  |
19 | |     Eq,
20 | | ))]
   | |___^
   |
   = note: see issue #54503 <https://github.com/rust-lang/rust/issues/54503> for more information
   = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)

The fix for this is to bump my MSRV, which I'm fine with doing. But the process for finding what version this feature was introduced in is convoluted and doesn't have any path from the error message. A good place for that information to live would the in the first comment of the tracking issue link. Adding the info to the RFC and stabilization issue would be nice too. The only place where this is recorded currently is the rust blog https://blog.rust-lang.org/2024/09/05/Rust-1.81.0.html#lint-reasons

Obviously this is just one case, but it's something I've seen happen a few times. The underlying goal of this issue is that the link to the tracking issue is not a dead end for fixing the issue, but instead contains enough information to fix immediately.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the tracking issue template and the related RFC and stabilization issue templates; the issue names these locations but no filenames. Check how stabilization details are currently recorded, then add the stabilization version where requested and verify that the tracking-issue link provides enough information to identify the version needed to resolve the error.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.