Repository navigation
docs: document all five npm run check sub-checks - #800
Merged
Merged
Conversation
CONTRIBUTING.md equated npm run check with the three sub-checks the "Lint repository" CI job enforces (check:format, check:spelling, check:markdown), and stated it "covers" only those three. It actually expands to five scripts: the three above plus check:links (network- dependent, zero doc mentions) and check:community-group-links (needs GH_TOKEN, unconditionally rewrites data/community-groups.json). Reworded step 5 and the Justfile note to list all five, flag the two that "Lint repository" does not run, and explain their side effects. Fixes #788 Signed-off-by: mrbobbytables <mrbobbytables@users.noreply.github.com>
Contributor
|
No description provided. |
# Conflicts: # CONTRIBUTING.md
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
CONTRIBUTING.md's "Making changes" step 5 said
npm run check"coverscheck:format (prettier), check:spelling (cspell), and check:markdown
(markdownlint)", equating it with the "Lint repository" CI job.
On main,
checkactually expands via_list:check:*to five scripts:check:format,check:links,check:markdown,check:spelling, andcheck:community-group-links..github/workflows/ci.yml's lint job runsonly the first three.
The extra two have real side effects a contributor should know about before
running the "check" that gates their PR:
check:linksis network-dependent and can fail for reasons unrelated tothe change.
check:community-group-linksneedsGH_TOKENand unconditionally rewritesdata/community-groups.json.Reworded step 5 and the Justfile note to list all five sub-checks, note
which three "Lint repository" actually enforces, and explain when to commit
the community-group-links refresh.
Fixes #788