Skip to content

Commit ae27bb2

Browse files
committed
a few more updates
1 parent 2d2b1d4 commit ae27bb2

File tree

5 files changed

+24
-10
lines changed

5 files changed

+24
-10
lines changed

src/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
- [Design](./code-considerations/design/summary.md)
2020
- [Public APIs](./code-considerations/design/public-apis.md)
2121
- [Breaking changes](./code-considerations/breaking-changes/summary.md)
22-
- [Breaking behavior](./code-considerations/breaking-changes/behavior.md)
23-
- [New trait impls](./code-considerations/breaking-changes/new-trait-impls.md)
22+
- [Breakage from changing behavior](./code-considerations/breaking-changes/behavior.md)
23+
- [Breakage from new trait impls](./code-considerations/breaking-changes/new-trait-impls.md)
2424
- [`#[fundamental]` types](./code-considerations/breaking-changes/fundamental.md)
2525
- [Safety and soundness](./code-considerations/safety-and-soundness/summary.md)
2626
- [Generics and unsafe](./code-considerations/safety-and-soundness/generics-and-unsafe.md)

src/code-considerations/design/summary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Most of the considerations in this guide are quality in some sense. This section
66

77
## For reviewers
88

9-
Think about how you would implement a feature and whether your approach would differ from what's being proposed. What trade-offs are being made? Is the weighting of those trade-offs the most appropriate?
9+
Think about how you would implement a feature and whether your approach would differ from what's being proposed. What trade-offs are being made? Is the weighting of those trade-offs the most appropriate?

src/feature-lifecycle/new-unstable-features.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
New unstable features can be added and approved without going through a Libs FCP. There should be some buy-in from Libs that a feature is desirable and likely to be stabilized at some point before landing though.
66

7+
If you're not sure, open an issue against `rust-lang/rust` first suggesting the feature before developing it.
8+
79
All public items in the standard library need a `#[stable]` or `#[unstable]` attribute on them. When a feature is first added, it gets a `#[unstable]` attribute.
810

911
Before a new feature is merged, those `#[unstable]` attributes need to be linked to a [tracking issue](./tracking-issues.md).

src/feature-lifecycle/stabilization.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,21 @@
22

33
**Status:** Stub
44

5-
Feature stabilization involves replacing `#[unstable]` attributes for a feature with `#[stable]` ones.
5+
Feature stabilization involves adding `#[stable]` attributes. They may be introduced alongside new trait impls or replace existing `#[unstable]` attributes.
6+
7+
Stabilization goes through the Libs FCP process, which occurs on the [tracking issue](./tracking-issues.md) for the feature.
68

79
## Before writing a PR to stabilize a feature
810

9-
Check to see if a FCP has completed on the [tracking issue](./tracking-issues.md). If not, either ping `@rust-lang/libs` or leave a comment asking about the status of the feature.
11+
Check to see if a FCP has completed first. If not, either ping `@rust-lang/libs` or leave a comment asking about the status of the feature.
12+
13+
This will save you from opening a stabilization PR and having it need regular rebasing while the FCP process runs its course.
14+
15+
## Writing a stabilization PR
16+
17+
- Replace any `#[unstable]` attributes for the given feature with stable ones. The value of the `since` field is usually the current `nightly` version.
18+
- Remove any `#![feature()]` attributes that were previously required.
19+
- Submit a PR with a stabilization report.
1020

1121
## When there's `const` involved
1222

src/getting-started.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,24 @@
22

33
**Status:** Stub
44

5-
> Everything I wish I knew before somebody gave me `r+`
6-
75
Welcome to the standard library!
86

97
This guide is an effort to capture some of the context needed to develop and maintain the Rust standard library. Its goal is to help members of the Libs team share the process and experience they bring to working on the standard library so other members can benefit. It’ll probably accumulate a lot of trivia that might also be interesting to members of the wider Rust community.
108

11-
## If you’re ever unsure…
9+
## Where to get help
10+
11+
Maintaining the standard library can feel like a daunting responsibility!
1212

13-
Maintaining the standard library can feel like a daunting responsibility! Through [`highfive`], the automated reviewer assignment, you’ll find yourself dropped into a lot of new contexts.
13+
Ping the `@rust-lang/libs-impl` or `@rust-lang/libs` teams on GitHub anytime.
1414

15-
Ping the `@rust-lang/libs-impl` or `@rust-lang/libs` teams on GitHub anytime. We’re all here to help!
15+
You can also reach out in the [`t-libs` stream on Zulip](https://rust-lang.zulipchat.com/#narrow/stream/219381-t-libs/).
1616

1717
## A tour of the standard library
1818

1919
**Status:** Stub
2020

21+
The standard library codebase lives in the [`rust-lang/rust`](https://github.com/rust-lang/rust) repository under the `/library` directory.
22+
2123
The standard library is made up of three crates that exist in a loose hierarchy:
2224

2325
- `core`: dependency free and makes minimal assumptions about the runtime environment.

0 commit comments

Comments
 (0)