rustc-dev-guide icon indicating copy to clipboard operation
rustc-dev-guide copied to clipboard

stabilization template, docs

Open nikomatsakis opened this issue 11 months ago • 5 comments

This PR updates the stabilization docs and introduces a new stabilization template based on a series of questions.

cc @rust-lang/lang -- this is designed to help us get the information we need cc @rust-lang/compiler -- this is designed to ask questions to help gauge implementation quality cc @rust-lang/types -- this is designed to surface potential type system interactons cc @rust-lang/style, @rust-lang/rust-analyzer, and @rust-lang/lang-docs -- I'd like advice on how to advice users about doing updates outside of rustc.

nikomatsakis avatar Jan 23 '25 20:01 nikomatsakis

@nikomatsakis do you mind if I push some changes to this PR (to address some of the more trivial nits)?

This draft stabilization template is somewhat funny in that people are already using it for stabilization reports, but it's in an open PR xD Maybe we should merge an intermediate version? It obviously won't be perfect, but at least new stabilization reports would have something (live) to reference, and improvements to the template could be made in follow-ups following more feedback?

Or I guess, this could wait for more thorough discussions during All Hands?

jieyouxu avatar Apr 29 '25 12:04 jieyouxu

people have been using this or have been asked to use this. We should really merge this now.

We should move it to the forge instead and also address all the feedback but should happen later.

Noratrieb avatar Jun 16 '25 11:06 Noratrieb

I spoke with @nikomatsakis and @traviscross, and I'll try to address some outstanding feedback to push towards landing an initial imperfect version in rustc-dev-guide (with a lang team vibeck).

Later, I'll move this initial stabilization template to Forge which seems like a better home than rustc-dev-guide, and follow-up improvements can be done there.

jieyouxu avatar Jun 19 '25 09:06 jieyouxu

:warning: Warning :warning:

rustbot avatar Jun 19 '25 09:06 rustbot

(This should probably be squashed prior to merge, intermediate commits intended for review only)

jieyouxu avatar Jun 19 '25 11:06 jieyouxu

@traviscross is this blocked on you ("with a lang team vibeck")? I'm not clear on what the next steps are and would really like to get this merged in some form so we can be appending more "things to think about" to the stabilization report :thinking: My preference would be to merge this ASAP then move it to forge and iterate on it there given people seem to already be using this.

BoxyUwU avatar Jul 22 '25 22:07 BoxyUwU

It was waiting on me. I've finished making my way through reviewing and revising. I plan to have a final look over it tomorrow or Friday, and then I'll get it merged.

traviscross avatar Jul 23 '25 06:07 traviscross

Revised and merged. Thanks to @nikomatsakis for putting this forward, to @jieyouxu for incorporating the feedback of others, and to the many who provided this helpful feedback.

We'll now make sure that everyone gets a copy of the new TPS report...

traviscross avatar Jul 25 '25 22:07 traviscross

Thanks for revising it! I'll move the stabilization content and template to Forge, as this is definitely more "policy for stabilization" side, and further updates can be made at Forge.

I'll make sure to leave links to the Forge docs.

EDIT: actually, this is not quite as easy as I hoped, because there are "implementation details" interwined with "required steps / policy". I'll look into adjusting the organization to make it clearer the "required steps" vs "how to do it". But getting at least docs to exist somewhere is already much better than it being nowhere.

jieyouxu avatar Jul 26 '25 09:07 jieyouxu