Skip to content

Commit 9d9c029

Browse files
committed
doc: Contributing.md: mention of make tidy
1 parent a029ea3 commit 9d9c029

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,10 @@ Some common make targets are:
151151
command above as we only build the stage1 compiler, not the entire thing).
152152
You can also leave off the `-rpass` to run all stage1 test types.
153153
- `make check-stage1-coretest` - Run stage1 tests in `libcore`.
154+
- `make tidy` - Check that the source code is in compliance with Rust's style
155+
guidelines. There is no official document describing Rust's full guidelines
156+
as of yet, but basic rules like 4 spaces for indentation and no more than 99
157+
characters in a single line should be kept in mind when writing code.
154158

155159
## Pull Requests
156160

@@ -177,6 +181,15 @@ you’re adding something to the standard library, try
177181

178182
This will not rebuild the compiler, but will run the tests.
179183

184+
Please make sure your pull request is in compliance with Rust's style
185+
guidelines by running
186+
187+
$ make tidy
188+
189+
Make this check before every pull request (and every new commit in a pull
190+
request) ; you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
191+
before every push to make sure you never forget to make this check.
192+
180193
All pull requests are reviewed by another person. We have a bot,
181194
@rust-highfive, that will automatically assign a random person to review your
182195
request.

0 commit comments

Comments
 (0)