summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorCobrand <cobrandw@gmail.com>2016-09-03 12:41:02 +0200
committerCobrand <cobrandw@gmail.com>2016-09-03 12:51:16 +0200
commit9d9c029a6674787d600e0ea40baa9ca55eb87103 (patch)
treee65b8bec4dc742f75b7f7c99325bda0ed8e1c57a /CONTRIBUTING.md
parentAuto merge of #35957 - alexcrichton:macros-1.1, r=nrc (diff)
downloadgrust-9d9c029a6674787d600e0ea40baa9ca55eb87103.tar.gz
grust-9d9c029a6674787d600e0ea40baa9ca55eb87103.tar.bz2
grust-9d9c029a6674787d600e0ea40baa9ca55eb87103.tar.xz
doc: Contributing.md: mention of `make tidy`
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4e6cd6c978..4c0f93c370 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -151,6 +151,10 @@ Some common make targets are:
151 command above as we only build the stage1 compiler, not the entire thing). 151 command above as we only build the stage1 compiler, not the entire thing).
152 You can also leave off the `-rpass` to run all stage1 test types. 152 You can also leave off the `-rpass` to run all stage1 test types.
153- `make check-stage1-coretest` - Run stage1 tests in `libcore`. 153- `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.
154 158
155## Pull Requests 159## Pull Requests
156 160
@@ -177,6 +181,15 @@ you’re adding something to the standard library, try
177 181
178This will not rebuild the compiler, but will run the tests. 182This will not rebuild the compiler, but will run the tests.
179 183
184Please make sure your pull request is in compliance with Rust's style
185guidelines by running
186
187 $ make tidy
188
189Make this check before every pull request (and every new commit in a pull
190request) ; you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
191before every push to make sure you never forget to make this check.
192
180All pull requests are reviewed by another person. We have a bot, 193All pull requests are reviewed by another person. We have a bot,
181@rust-highfive, that will automatically assign a random person to review your 194@rust-highfive, that will automatically assign a random person to review your
182request. 195request.