Skip to content

doc: mention markdown linting in BUILDING.md #28578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: mention markdown linting in BUILDING.md #28578

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
  • Loading branch information
@srcmake
srcmake committed Jul 6, 2019
commit 112b4ef4a0eea28aa957b247502d2d609e6041cc
3 changes: 1 addition & 2 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`):
Expand Down