Skip to content

Commit d0bcdf3

Browse files
committed
Merge pull request rust-lang#31 from SimonSapin/patch-1
[Meta] Update README.md based on mailing-list
2 parents 711f533 + 003965e commit d0bcdf3

File tree

1 file changed

+75
-2
lines changed

1 file changed

+75
-2
lines changed

README.md

Lines changed: 75 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,78 @@
11
# Rust RFCs
22

3-
Major changes to Rust are designed through an RFC process.
3+
Many changes, including bug fixes and documentation improvements can be
4+
implemented and reviewed via the normal GitHub pull request workflow.
45

5-
Details to come.
6+
Some changes though are "substantial", and we ask that these be put
7+
through a bit of a design process and produce a consensus among the Rust
8+
community and the [core team].
9+
10+
The "RFC" (request for comments process) is intended to provide a
11+
consistent and controlled path for new features to enter the language
12+
and standard libraries, so that all stakeholders can be confident about
13+
the direction the language is evolving in.
14+
15+
## When you need to follow this process
16+
17+
You need to follow this process if you intend to make "substantial"
18+
changes to the Rust distribution. What constitutes a "substantial"
19+
change is evolving based on community norms, but may include the following.
20+
21+
- Any semantic or syntactic change to the language that is not a bugfix.
22+
- Changes to the interface between the compiler and libraries,
23+
including lang items and intrinsics.
24+
- Additions to `std`
25+
26+
Some changes do not require an RFC:
27+
28+
- Rephrasing, reorganizing, refactoring, or otherwise "changing shape
29+
does not change meaning".
30+
- Additions that strictly improve objective, numerical quality
31+
criteria (warning removal, speedup, better platform coverage, more
32+
parallelism, trap more errors, etc.)
33+
- Additions only likely to be _noticed by_ other developers-of-rust,
34+
invisible to users-of-rust.
35+
36+
If you submit a pull request to implement a new feature without going
37+
through the RFC process, it may be closed with a polite request to
38+
submit an RFC first.
39+
40+
## What the process is
41+
42+
In short, to get a major feature added to Rust, one must first get the
43+
RFC merged into the RFC repo as a markdown file. At that point the RFC
44+
is 'active' and may be implemented with the goal of eventual inclusion
45+
into Rust.
46+
47+
* Fork the RFC repo http://github.com/rust-lang/rfcs
48+
* Copy `0000-template.md` to `active/0000-my-feature.md` (where
49+
'my-feature' is descriptive. don't assign an RFC number yet).
50+
* Fill in the RFC
51+
* Submit a pull request. The pull request is the time to get review of
52+
the design from the larger community.
53+
* Build consensus and integrate feedback. RFCs that have broad support
54+
are much more likely to make progress than those that don't receive any
55+
comments.
56+
* Eventually, somebody on the [core team] will either accept the RFC by
57+
merging the pull request and assigning the RFC a number, at which point
58+
the RFC is 'active', or reject it by closing the pull request.
59+
60+
Once an RFC becomes active then authors may implement it and submit the
61+
feature as a pull request to the Rust repo. An 'active' is not a rubber
62+
stamp, and in particular still does not mean the feature will ultimately
63+
be merged; it does mean that in principle all the major stakeholders
64+
have agreed to the feature and are amenable to merging it.
65+
66+
Modifications to active RFC's can be done in followup PR's. An RFC that
67+
makes it through the entire process to implementation is considered
68+
'complete' and is moved to the 'complete' folder; an RFC that fails
69+
after becoming active is 'inactive' and moves to the 'inactive' folder.
70+
71+
### Help this is all too informal!
72+
73+
The process is intended to be as lightweight as reasonable for the
74+
present circumstances. As usual, we are trying to let the process be
75+
driven by consensus and community norms, not impose more structure than
76+
necessary.
77+
78+
[core team]: https://github.com/mozilla/rust/wiki/Note-core-team

0 commit comments

Comments
 (0)