Skip to content

Commit 009582f

Browse files
ehusstraviscross
authored andcommitted
Link README to the new contributor guide
1 parent e858784 commit 009582f

File tree

1 file changed

+1
-15
lines changed

1 file changed

+1
-15
lines changed

README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,4 @@ This document is the primary reference for the Rust programming language.
44

55
## Contributor docs
66

7-
There are several pages for those working on the reference:
8-
9-
* [Authoring guide](https://github.com/rust-lang/reference/blob/master/docs/authoring.md): Guidelines for writing content.
10-
* [Review policy](https://github.com/rust-lang/reference/blob/master/docs/review-policy.md): Guidelines for reviewers.
11-
* [Grammar](https://github.com/rust-lang/reference/blob/master/docs/grammar.md): How the grammar syntax works.
12-
* [Attribute template](https://github.com/rust-lang/reference/blob/master/docs/attribute-template.md): The standard template for documenting an attribute.
13-
14-
## Running tests
15-
16-
There are several different kinds of tests you can run (these are enforced on CI):
17-
18-
* `mdbook test`: This will run the inline Rust codeblocks (internally it uses `rustdoc` to do this).
19-
* `cargo xtask style-check`: This will validate some style checks (see [authoring guide](docs/authoring.md)).
20-
* `cargo xtask linkcheck`: This will validate that markdown links aren't broken.
21-
* `cargo xtask test-all`: Runs all tests.
7+
See the [Reference Developer Guide](https://rust-lang.github.io/reference/reference-dev-guide/) for information on contributing to the Reference.

0 commit comments

Comments
 (0)