Skip to content

Commit 09caa12

Browse files
committed
add some tips to CONTRIBUTING.md to help with debugging this problem
1 parent 47449ea commit 09caa12

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -360,8 +360,10 @@ git add path/to/submodule
360360

361361
outside the submodule.
362362

363-
It can also be more convenient during development to set `submodules = false`
364-
in the `config.toml` to prevent `x.py` from resetting to the original branch.
363+
In order to prepare your PR, you can run the build locally by doing
364+
`./x.py build src/tools/TOOL`. If you will be editing the sources
365+
there, you may wish to set `submodules = false` in the `config.toml`
366+
to prevent `x.py` from resetting to the original branch.
365367

366368
## Writing Documentation
367369
[writing-documentation]: #writing-documentation

0 commit comments

Comments
 (0)