diff options
author | Tariq Ramlall <srcmake@gmail.com> | 2019-07-06 21:08:01 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-07-09 01:47:03 +0300 |
commit | 7e50bb3dce11988284c7ca9e2316c086aefac1e1 (patch) | |
tree | f2117ced6d2365066f4e4c131394a2ed8180a193 /BUILDING.md | |
parent | 4742e4dc3e2222d3b5a03edd4a0468ae77800819 (diff) |
doc: mention markdown linting in BUILDING.md
BUILDING.md mentioned JS and C++ linting were performed
in the 'make lint' command, but 'make lint' also
performs markdown linting. This commit updates the docs
to include markdown as one of the things being linted.
PR-URL: https://github.com/nodejs/node/pull/28578
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'BUILDING.md')
-rw-r--r-- | BUILDING.md | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/BUILDING.md b/BUILDING.md index abb47cf1294..7a17a24b595 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -322,8 +322,7 @@ Make sure the linter does not report any issues and that all tests pass. Please do not submit patches that fail either check. If you want to run the linter without running tests, use -`make lint`/`vcbuild lint`. It will run both JavaScript linting and -C++ linting. +`make lint`/`vcbuild lint`. It will lint JavaScript, C++, and Markdown files. If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): |