rust-lang
Move style guide
RFC 3309 moved the style guide to rust-lang/rust. In addition, the
link from
RFC 2436 to
the style guide does not seem to have ever worked, and the style guide
has never been available anywhere in rendered form.
Update RFC 2436 minimally to point to the rendered style guide.
Currently draft, until https://github.com/rust-lang/rust/pull/102239 gets merged.
I think we should definitely get rid of the specifics here as that's been an ongoing source of confusion. One of the things I heard when I first started contributing to rustfmt was that the rustfmt team of that time was entirely unaware that this rfc version of the style guide specifics existed here.
I've a couple questions more related to the execution of moving the guide into r-l/rust that I'll ask here:
- What's the plan for the repo where the guide is currently maintained? I feel like it should be functionally archived to avoid any confusion or bifurcation (though I don't have access to do this myself)
- Any thoughts on how we could potentially lower the frequency of revisiting topics that were previously discussed at length and resolved (e.g. are there any steps we should take to capture/point to past discussions to hopefully reduce the odds of r-l/rust getting spammed with "switch default from spaces to tabs" types of issues?)
- Perhaps something as simple as creating a small list of quick links to those past discussions to capture the frequently asked/requested items?
- Should we run a final triage pass over open issues/PRs in the current repo before migrating to see if there's anything that can be closed out and pulled in as part of the move, or should we move first and then recreate as needed?
@calebcartwright Regarding your first and third points, RFC 3309 mentions:
This RFC proposes to move the Rust style guide to the rust-lang/rust repository, rather than its current location in the RFCs repository. Style work may additionally take place in the
fmt-rfcsrepository (which this RFC proposes to revive). Larger style proposals may wish to start there rather than as PRs to the style guide. The style team may choose to change this process.
I think we should keep fmt-rfcs for now, and decide as a team if we want to continue using it or use some other process for larger pieces of style work.
@calebcartwright wrote:
Any thoughts on how we could potentially lower the frequency of revisiting topics that were previously discussed at length and resolved (e.g. are there any steps we should take to capture/point to past discussions to hopefully reduce the odds of r-l/rust getting spammed with "switch default from spaces to tabs" types of issues?)
- Perhaps something as simple as creating a small list of quick links to those past discussions to capture the frequently asked/requested items?
We've talked about having a similar FAQ for other frequently requested items, such as "make braces optional on if and other block constructs". I think we could add a few style items to that FAQ, and if the list of style items in that FAQ gets too long we could split out a style-specific FAQ and link to it.
https://github.com/rust-lang/rust/pull/102239 has been merged, so this can now be merged as well.