Skip to content
This repository was archived by the owner on Oct 9, 2018. It is now read-only.

Commit 44930c7

Browse files
committed
Update README for public release
1 parent 2e72a0a commit 44930c7

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@
33
This document collects the emerging principles, conventions, abstractions, and
44
best practices for writing Rust code.
55

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.
99

1010
Whenever feasible, guidelines provide specific examples from Rust's standard
1111
libraries.
1212

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.
1517

1618
### Building the document
1719

@@ -47,24 +49,24 @@ Every guideline has a status:
4749
* Untagged guidelines are considered well-accepted. _**Ed. note**: to
4850
begin with, there are almost none of these!_
4951

50-
#### Pre-draft stage
52+
### Guideline stabilization
5153

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:
5657

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.
5861

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).
6064

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.
6267

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.
6870

6971
### What's in this document
7072

0 commit comments

Comments
 (0)