Skip to content

Commit c9ed4be

Browse files
committed
docs(contrib): Tracking issues generally come before implementation
1 parent 7da5caa commit c9ed4be

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

src/doc/contrib/src/process/unstable.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,6 @@ feature will only be usable on the nightly channel, and requires a specific
55
opt-in by the user. Small changes can skip this process, but please consult
66
with the Cargo team first.
77

8-
## Unstable feature opt-in
9-
10-
For features that require behavior changes or new syntax in `Cargo.toml`, then
11-
it will need a `cargo-features` value placed at the top of `Cargo.toml` to
12-
enable it. The process for adding a new feature is described in the
13-
[`features` module]. Code that implements the feature will need to manually
14-
check that the feature is enabled for the current manifest.
15-
16-
For features that add new command-line flags, config options, or environment
17-
variables, then the `-Z` flags will be needed to enable them. The [`features`
18-
module] also describes how to add these. New flags should use the
19-
`fail_if_stable_opt` method to check if the `-Z unstable-options` flag has
20-
been passed.
21-
22-
## Unstable documentation
23-
24-
Every unstable feature should have a section added to the [unstable chapter]
25-
describing how to use the feature.
26-
This can also serve as a place for the final documentation to live until its stabilized.
27-
28-
[unstable chapter]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/unstable.md
29-
308
## Tracking issues
319

3210
Each unstable feature should get a [tracking issue]. These issues are
@@ -59,6 +37,28 @@ something is only partially implemented, it may have both
5937
[S-accepted]: https://github.com/rust-lang/cargo/labels/S-accepted
6038
[S-waiting-on-feedback]: https://github.com/rust-lang/cargo/labels/S-waiting-on-feedback
6139

40+
## Unstable feature opt-in
41+
42+
For features that require behavior changes or new syntax in `Cargo.toml`, then
43+
it will need a `cargo-features` value placed at the top of `Cargo.toml` to
44+
enable it. The process for adding a new feature is described in the
45+
[`features` module]. Code that implements the feature will need to manually
46+
check that the feature is enabled for the current manifest.
47+
48+
For features that add new command-line flags, config options, or environment
49+
variables, then the `-Z` flags will be needed to enable them. The [`features`
50+
module] also describes how to add these. New flags should use the
51+
`fail_if_stable_opt` method to check if the `-Z unstable-options` flag has
52+
been passed.
53+
54+
## Unstable documentation
55+
56+
Every unstable feature should have a section added to the [unstable chapter]
57+
describing how to use the feature.
58+
This can also serve as a place for the final documentation to live until its stabilized.
59+
60+
[unstable chapter]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/unstable.md
61+
6262
## Pre-Stabilization
6363

6464
Once an unstable feature is "complete", the search for users to test

0 commit comments

Comments
 (0)