|
3 | 3 | This document collects the emerging principles, conventions, abstractions, and
|
4 | 4 | best practices for writing Rust code.
|
5 | 5 |
|
6 |
| -Since Rust is evolving at a rapid pace, these guidelines are very |
7 |
| -preliminary. The hope is that writing them down explicitly will help drive |
8 |
| -discussion, consensus and adoption. |
| 6 | +Since Rust is evolving at a rapid pace, these guidelines are |
| 7 | +preliminary. The hope is that writing them down explicitly will help |
| 8 | +drive discussion, consensus and adoption. |
9 | 9 |
|
10 | 10 | Whenever feasible, guidelines provide specific examples from Rust's standard
|
11 | 11 | libraries.
|
12 | 12 |
|
13 |
| -Until the guidelines are moved into `rust-lang` (see below), you can |
14 |
| -find a rendered snapshot at [http://aturon.github.io/](http://aturon.github.io/). |
| 13 | +For now, you can find a rendered snapshot at |
| 14 | +[http://aturon.github.io/](http://aturon.github.io/). After |
| 15 | +[some infrastructure work](https://github.com/aturon/rust-guidelines/issues/17), the snapshot will move somewhere more |
| 16 | +official. |
15 | 17 |
|
16 | 18 | ### Building the document
|
17 | 19 |
|
@@ -47,24 +49,24 @@ Every guideline has a status:
|
47 | 49 | * Untagged guidelines are considered well-accepted. _**Ed. note**: to
|
48 | 50 | begin with, there are almost none of these!_
|
49 | 51 |
|
50 |
| -#### Pre-draft stage |
| 52 | +### Guideline stabilization |
51 | 53 |
|
52 |
| -To begin with, this document will exist under |
53 |
| -https://github.com/aturon/rust-guidelines and will have no official status. |
54 |
| -This brief early stage is mainly intended as a sanity check, and to try to get |
55 |
| -the draft in as good of shape as possible before bringing it to the full community. |
| 54 | +One purpose of these guidelines is to reach decisions on a number of |
| 55 | +cross-cutting API and stylistic choices. Discussion and development of the |
| 56 | +guidelines will happen through: |
56 | 57 |
|
57 |
| -_Pull requests very welcome!_ |
| 58 | +1. **Primarily**: http://discuss.rust-lang.org/, using the Guidelines category. |
| 59 | +2. On the github issue tracker. |
| 60 | +3. Pull requests to add or change guidelines. |
58 | 61 |
|
59 |
| -#### First draft stage |
| 62 | +Guidelines that are under development or discussion will be marked with the |
| 63 | +status **[RFC]** (or **[OPEN]** in the very early stages). |
60 | 64 |
|
61 |
| -After completing a first draft of the guidelines, we will: |
| 65 | +The Rust team will hold meetings to move guidelines from **[RFC]** to approved |
| 66 | +(untagged) status, similar to the current practice for RFCs. |
62 | 67 |
|
63 |
| -1. Move the repository into the `rust-lang` organization, and |
64 |
| -2. Begin a formal process to migrate guidelines to fully accepted status. |
65 |
| - |
66 |
| -The precise mechanics for guideline adoption are to be determined, but will |
67 |
| -likely resemble the Rust RFC process. |
| 68 | +The specifics of the process will evolve over time, and approved guidelines may |
| 69 | +still change. |
68 | 70 |
|
69 | 71 | ### What's in this document
|
70 | 72 |
|
|
0 commit comments