doc: mention markdown linting in BUILDING.md #28578
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
build
Trott
reviewed
Jul 6, 2019
BUILDING.md
Outdated
| @@ -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 run JavaScript, C++, and Markdown linting. | |||
There was a problem hiding this comment.
Suggested change
| `make lint`/`vcbuild lint`. It will run JavaScript, C++, and Markdown linting. | |
| `make lint`/`vcbuild lint`. It will lint JavaScript, C++, and Markdown files. |
Trott
approved these changes
Jul 6, 2019
addaleax
approved these changes
Jul 6, 2019
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.
srcmake
force-pushed
the
feature/lint-on-doc
branch
from
fb98bc5
to
112b4ef
Compare
|
Updated with Trott's suggestion. The wording is much nicer now. |
BridgeAR
approved these changes
Jul 8, 2019
Trott
added
the
author ready
|
Landed in 7e50bb3 |
Trott
pushed a commit
to Trott/io.js
that referenced
this pull request
Jul 8, 2019
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: nodejs#28578 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos
pushed a commit
that referenced
this pull request
Jul 20, 2019
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: #28578 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This was referenced Jul 23, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the Running Tests section of BUILDING.md, there's a sentence that says
make lintruns JavaScript and C++ linting. However,make lintalso runs a Markdown linter. This PR updates that sentence in the documentation to mention that Markdown linting is run.Which is super useful to know since small documentation change PRs don't need the full test suite run, and
make lintis good enough for testing. (I think.)Checklist
make lint