docs: add Lint repository CI check step to Making changes - #583
Merged
Merged
Conversation
CONTRIBUTING.md's 'Making changes' section told contributors to run test:unit and build but never mentioned the 'Lint repository' CI job (check:format, check:spelling, check:markdown), so a first-time contributor could pass every documented step and still fail CI on lint. Add a step covering npm run check and how to fix each failure class. Hive-Run: #569 Hive-Plan: docs-contributing-lint-checks Hive-Spec: contributing-guide#making-changes-lint-step Signed-off-by: mrbobbytables <mrbobbytables@users.noreply.github.com>
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
2 participants
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.
Summary
Adds a step to CONTRIBUTING.md's "Making changes" section documenting the
"Lint repository" CI job (
check:format,check:spelling,check:markdown), which was previously unmentioned anywhere in the repo'sdocs. Without it, a contributor could follow every documented step and
still fail CI on their first PR due to an undocumented required check.
Closes #569
Verification
npm run check:formatpasses on the updated file (rannpm run fix:formatto apply Prettier's formatting to the new list items).npm run check:spelling— 0 issues.(
fix:format,.cspell.yml,.markdownlint.yaml) againstpackage.jsonand.github/workflows/ci.yml.Checklist
git commit -s)— hive: backend=copilot model=claude-sonnet-5
🐝 Hive Agent:
contributor| SHA:3ecdfa7