Skip to content

Commit

Permalink
doc: run tests before landing changes
Browse files Browse the repository at this point in the history
The Collaborator Guide suggests running tests after pushing changes to
the main repository. Tests should be run before then so move the
instructions earlier.

Instructions are also simplified and re-written to not exclude Windows.

PR-URL: #12416
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information
Trott authored and evanlucas committed May 2, 2017
1 parent af0067c commit 3fc25dc
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,10 @@ commit logs, ensure that they are properly formatted, and add
* The commit message text must conform to the
[commit message guidelines](./CONTRIBUTING.md#step-3-commit).

Run tests (`make -j4 test` or `vcbuild test`). Even though there was a
successful continuous integration run, other changes may have landed on master
since then, so running the tests one last time locally is a good practice.

Time to push it:

```text
Expand All @@ -463,11 +467,6 @@ your pull request shows the purple merged status then you should still
add the "Landed in <commit hash>..<commit hash>" comment if you added
multiple commits.

* `./configure && make -j8 test`
* `-j8` builds node in parallel with 8 threads. Adjust to the number
of cores or processor-level threads your processor has (or slightly
more) for best results.

### I Just Made a Mistake

* Ping a CTC member.
Expand Down

0 comments on commit 3fc25dc

Please sign in to comment.