From 09caa12a51cb61a9841ac072103b6300aa5fb1fd Mon Sep 17 00:00:00 2001 From: Niko Matsakis Date: Thu, 21 Sep 2017 13:46:52 -0400 Subject: [PATCH] add some tips to CONTRIBUTING.md to help with debugging this problem --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a86742d7bd4..d67a74f681e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -360,8 +360,10 @@ git add path/to/submodule outside the submodule. -It can also be more convenient during development to set `submodules = false` -in the `config.toml` to prevent `x.py` from resetting to the original branch. +In order to prepare your PR, you can run the build locally by doing +`./x.py build src/tools/TOOL`. If you will be editing the sources +there, you may wish to set `submodules = false` in the `config.toml` +to prevent `x.py` from resetting to the original branch. ## Writing Documentation [writing-documentation]: #writing-documentation