Skip to content

Commit 4024cdf

Browse files
committed
update some more sections
1 parent c938da2 commit 4024cdf

File tree

9 files changed

+108
-83
lines changed

9 files changed

+108
-83
lines changed

src/SUMMARY.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,38 @@
44

55
[Getting started](./getting-started.md)
66

7+
[Reviewer checklist](./reviewer-checklist.md)
8+
9+
---
10+
11+
- [The feature lifecycle](./feature-lifecycle/summary.md)
12+
- [Landing new features](./feature-lifecycle/new-unstable-features.md)
13+
- [Using tracking issues](./feature-lifecycle/tracking-issues.md)
14+
- [Stabilizing features](./feature-lifecycle/stabilization.md)
15+
- [Deprecating features](./feature-lifecycle/deprecation.md)
16+
17+
---
18+
19+
- [Code considerations](./code-considerations/summary.md)
20+
- [Design](./code-considerations/design/summary.md)
21+
- [Public APIs](./code-considerations/design/public-apis.md)
22+
- [Breaking changes](./code-considerations/breaking-changes/summary.md)
23+
- [Breakage from changing behavior](./code-considerations/breaking-changes/behavior.md)
24+
- [Breakage from new trait impls](./code-considerations/breaking-changes/new-trait-impls.md)
25+
- [`#[fundamental]` types](./code-considerations/breaking-changes/fundamental.md)
26+
- [Safety and soundness](./code-considerations/safety-and-soundness/summary.md)
27+
- [Generics and unsafe](./code-considerations/safety-and-soundness/generics-and-unsafe.md)
28+
- [Drop and `#[may_dangle]`](./code-considerations/safety-and-soundness/may-dangle.md)
29+
- [`std::mem` and exclusive references](./code-considerations/safety-and-soundness/mem-and-exclusive-refs.md)
30+
- [Using unstable language features](./code-considerations/using-unstable-lang/summary.md)
31+
- [Const generics](./code-considerations/using-unstable-lang/const-generics.md)
32+
- [Specialization](./code-considerations/using-unstable-lang/specialization.md)
33+
- [Performance](./code-considerations/performance/summary.md)
34+
- [When to `#[inline]`](./code-considerations/performance/inline.md)
35+
736
---
837

9-
# The feature lifecycle
10-
11-
- [Landing new features](./feature-lifecycle/new-unstable-features.md)
12-
- [Using tracking issues](./feature-lifecycle/tracking-issues.md)
13-
- [Stabilizing features](./feature-lifecycle/stabilization.md)
14-
- [Deprecating features](./feature-lifecycle/deprecation.md)
15-
16-
# Code considerations
17-
18-
- [Reviewer checklist](./code-considerations/reviewer-checklist.md)
19-
- [Design](./code-considerations/design/summary.md)
20-
- [Public APIs](./code-considerations/design/public-apis.md)
21-
- [Breaking changes](./code-considerations/breaking-changes/summary.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)
24-
- [`#[fundamental]` types](./code-considerations/breaking-changes/fundamental.md)
25-
- [Safety and soundness](./code-considerations/safety-and-soundness/summary.md)
26-
- [Generics and unsafe](./code-considerations/safety-and-soundness/generics-and-unsafe.md)
27-
- [Drop and `#[may_dangle]`](./code-considerations/safety-and-soundness/may-dangle.md)
28-
- [`std::mem` and exclusive references](./code-considerations/safety-and-soundness/mem-and-exclusive-refs.md)
29-
- [Using unstable language features](./code-considerations/using-unstable-lang/summary.md)
30-
- [Const generics](./code-considerations/using-unstable-lang/const-generics.md)
31-
- [Specialization](./code-considerations/using-unstable-lang/specialization.md)
32-
- [Performance](./code-considerations/performance/summary.md)
33-
- [When to `#[inline]`](./code-considerations/performance/inline.md)
34-
35-
# Tools and bots
36-
37-
- [`@bors`](./tools-and-bots/bors.md)
38-
- [`@rust-timer`](./tools-and-bots/timer.md)
39-
- [`@craterbot`](./tools-and-bots/crater.md)
38+
- [Tools and bots](./tools-and-bots/summary.md)
39+
- [`@bors`](./tools-and-bots/bors.md)
40+
- [`@rust-timer`](./tools-and-bots/timer.md)
41+
- [`@craterbot`](./tools-and-bots/crater.md)

src/code-considerations/reviewer-checklist.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

src/code-considerations/safety-and-soundness/may-dangle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ struct OptionCell<T> {
3838

3939
## For reviewers
4040

41-
If there's a manual `Drop` implementation, consider whether `#[may_dangle]` is appropriate. If it is, make sure there's a `PhantomData<T>` too either through `Unique<T>` or manually.
41+
If there's a manual `Drop` implementation, consider whether `#[may_dangle]` is appropriate. If it is, make sure there's a `PhantomData<T>` too either through `Unique<T>` or as a field directly.

src/code-considerations/safety-and-soundness/summary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ The rules around what's sound and what's not can be subtle. See the [Unsafe Code
99
## For reviewers
1010

1111
Look out for any unsafe blocks. If they're optimizations consider whether they're actually necessary. If the unsafe code is necessary then always feel free to ping somebody to help review it.
12+
13+
Look at the level of test coverage for the new unsafe code. Tests do catch bugs!

src/code-considerations/summary.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Code considerations
2+
3+
Code considerations capture our experiences working on the standard library for all contributors. If you come across something new or unexpected then a code consideration is a great place to record it. Then other contributors and reviewers can find it by searching the guide.
4+
5+
## How to write a code consideration
6+
7+
Code considerations are a bit like guidelines. They should try make concrete recommendations that reviewers and contributors can refer to in discussions. A link to a real case where this was discussed or tripped us up is good to include.
8+
9+
Code considerations should also try include a _For reviewers_ section. These can call out specific things to look out for in reviews that could suggest the consideration applies. They can also include advice on how to apply it.
10+
11+
It's more important that we capture these experiences _somehow_ though, so don't be afraid to drop some sketchy notes in and debate the details later!

src/feature-lifecycle/summary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# The feature lifecycle
2+
3+
**Status:** Stub

src/reviewer-checklist.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Reviewer checklist
2+
3+
**Status:** Stub
4+
5+
Check the [getting started](./getting-started.md) guide for an introduction to developing in the standard library.
6+
7+
If you'd like to reassign the PR, you can:
8+
9+
```
10+
r? @user
11+
```
12+
13+
## Before you review
14+
15+
- [ ] Is this a [stabilization](./feature-lifecycle/stabilization.md) or [deprecation](./feature-lifecycle/deprecation.md)?
16+
- [ ] Make sure there's a completed FCP somewhere for it.
17+
- [ ] Ping `@rust-lang/libs` for input.
18+
19+
## As you review
20+
21+
Look out for code considerations:
22+
23+
- [ ] [Design](./code-considerations/design/summary.md)
24+
- [ ] [Breaking changes](./code-considerations/breaking-changes/summary.md)
25+
- [ ] [Safety and soundness](./code-considerations/safety-and-soundness/summary.md)
26+
- [ ] [Use of unstable language features](./code-considerations/using-unstable-lang/summary.md)
27+
- [ ] [Performance](./code-considerations/performance/summary.md)
28+
29+
## Before you merge
30+
31+
- [ ] Is the commit log tidy? Avoid merge commits, these can be squashed down.
32+
- [ ] Can this change be rolled up?
33+
- [ ] Is this a [new unstable feature](./feature-lifecycle/new-unstable-features.md)?
34+
- [ ] Create a [tracking issue](./feature-lifecycle/tracking-issues.md).
35+
- [ ] Update the `#[unstable]` attributes to point to it.
36+
37+
## When you're ready
38+
39+
Use [`@bors`](./tools-and-bots/bors.md) to merge the pull request.
40+
41+
To roll up:
42+
43+
```
44+
@bors r+ rollup
45+
```
46+
47+
or just:
48+
49+
```
50+
@bors r+
51+
```

src/tools-and-bots/bors.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ You can approve a PR with:
99
```
1010
@bors r+
1111
```
12+
13+
## Rolling up
14+
15+
For Libs PRs, rolling up is usually fine, in particular if it's only a new unstable addition or if it only touches docs. See the [rollup guidelines](https://forge.rust-lang/org/compiler/reviews.md#rollups) for more details on when to rollup.

src/tools-and-bots/summary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Tools and bots
2+
3+
**Status:** Stub

0 commit comments

Comments
 (0)