Skip to content

Commit 784f90e

Browse files
committed
Make Stabilization Template markdown copy friendly
1 parent fa8dce1 commit 784f90e

File tree

1 file changed

+62
-27
lines changed

1 file changed

+62
-27
lines changed

src/stabilization_report_template.md

Lines changed: 62 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,89 @@
11
# Stabilization report template
22

33
> **What is this?** This is a template to use for [stabilization reports](./stabilization_guide.md). It consists of a series of questions that aim to provide the information most commonly needed and to help reviewers be more likely to identify potential problems up front. Not all parts of the template will apply to all stabilizations. Feel free to put N/A if a question doesn't seem to apply to your case.
4+
>
5+
> You can copy the following template after the separator and edit it as Markdown, replacing the *TODO* placeholders with answers.
46
5-
## General design
7+
---
68

7-
### What is the RFC for this feature and what changes have occurred to the user-facing design since the RFC was finalized?
9+
> ## General design
810
9-
### What behavior are we committing to that has been controversial? Summarize the major arguments pro/con.
11+
> ### What is the RFC for this feature and what changes have occurred to the user-facing design since the RFC was finalized?
1012
11-
### Are there extensions to this feature that remain unstable? How do we know that we are not accidentally committing to those?
13+
*TODO*
1214

13-
## Has a call-for-testing period been conducted? If so, what feedback was received?
15+
> ### What behavior are we committing to that has been controversial? Summarize the major arguments pro/con.
1416
15-
## Implementation quality
17+
*TODO*
1618

17-
### Summarize the major parts of the implementation and provide links into the code (or to PRs)
19+
> ### Are there extensions to this feature that remain unstable? How do we know that we are not accidentally committing to those?
1820
19-
An example for async closures: https://rustc-dev-guide.rust-lang.org/coroutine-closures.html
21+
*TODO*
2022

21-
### Summarize existing test coverage of this feature
23+
> ## Has a Call for Testing period been conducted? If so, what feedback was received?
2224
23-
- What does the test coverage landscape for this feature look like?
24-
- (Positive/negative) Behavioral tests?
25-
- (Positive/negative) Interface tests? (e.g. compiler cli interface)
26-
- Maybe link to test folders or individual tests (ui/codegen/assembly/run-make tests, etc.)
27-
- Are there any (intentional/unintentional) gaps in test coverage?
25+
*TODO*
2826

29-
### What outstanding bugs in the issue tracker involve this feature? Are they stabilization-blocking?
27+
> ## Implementation quality
3028
31-
### What FIXMEs are still in the code for that feature and why is it ok to leave them there?
29+
*TODO*
3230

33-
### Summarize contributors to the feature by name for recognition and assuredness that people involved in the feature agree with stabilization
31+
> ### Summarize the major parts of the implementation and provide links into the code (or to PRs)
32+
>
33+
> An example for async closures: <https://rustc-dev-guide.rust-lang.org/coroutine-closures.html>.
3434
35-
### Which tools need to be adjusted to support this feature. Has this work been done?
35+
*TODO*
3636

37-
*Consider rustdoc, clippy, rust-analyzer, rustfmt, rustup, docs.rs.*
37+
> ### Summarize existing test coverage of this feature
38+
>
39+
> - What does the test coverage landscape for this feature look like?
40+
> - (Positive/negative) Behavioral tests?
41+
> - (Positive/negative) Interface tests? (e.g. compiler cli interface)
42+
> - Maybe link to test folders or individual tests (ui/codegen/assembly/run-make tests, etc.)
43+
> - Are there any (intentional/unintentional) gaps in test coverage?
3844
39-
## Type system and execution rules
45+
*TODO*
4046

41-
### What compilation-time checks are done that are needed to prevent undefined behavior?
47+
> ### What outstanding bugs in the issue tracker involve this feature? Are they stabilization-blocking?
4248
43-
(Be sure to link to tests demonstrating that these tests are being done.)
49+
*TODO*
4450

45-
### Can users use this feature to introduce undefined behavior, or use this feature to break the abstraction of Rust and expose the underlying assembly-level implementation? (Describe.)
51+
> ### What FIXMEs are still in the code for that feature and why is it ok to leave them there?
4652
47-
### What updates are needed to the reference/specification? (link to PRs when they exist)
53+
*TODO*
4854

49-
## Common interactions
55+
> ### Summarize contributors to the feature by name for recognition and assuredness that people involved in the feature agree with stabilization
5056
51-
### Does this feature introduce new expressions and can they produce temporaries? What are the lifetimes of those temporaries?
57+
*TODO*
5258

53-
### What other unstable features may be exposed by this feature?
59+
> ### Which tools need to be adjusted to support this feature. Has this work been done?
60+
>
61+
> Consider rustdoc, clippy, rust-analyzer, rustfmt, rustup, docs.rs.
5462
63+
*TODO*
64+
65+
> ## Type system and execution rules
66+
67+
> ### What compilation-time checks are done that are needed to prevent undefined behavior?
68+
>
69+
> (Be sure to link to tests demonstrating that these tests are being done.)
70+
71+
*TODO*
72+
73+
> ### Can users use this feature to introduce undefined behavior, or use this feature to break the abstraction > of Rust and expose the underlying assembly-level implementation? (Describe.)
74+
75+
*TODO*
76+
77+
> ### What updates are needed to the reference/specification? (link to PRs when they exist)
78+
79+
*TODO*
80+
81+
> ## Common interactions
82+
83+
> ### Does this feature introduce new expressions and can they produce temporaries? What are the lifetimes of those temporaries?
84+
85+
*TODO*
86+
87+
> ### What other unstable features may be exposed by this feature?
88+
89+
*TODO*

0 commit comments

Comments
 (0)