docs: fix CONTRIBUTING.md Justfile/CI sync claim - #578
Merged
Merged
Conversation
The Justfile shortcuts section claimed 'just build'/'just import' are kept in sync with the 'Validate repository' and 'Import reference architectures' workflows, so a green local run implies a green CI run. Neither is accurate: 'Validate repository' (ci.yml) runs only test:unit:coverage/build:production plus format/spelling/markdown checks, none of the validate:* scripts 'just build' runs; several of those validators run in no workflow at all. Reword the paragraph to describe what the recipes actually cover and point contributors to npm run test:unit and npm run check to match the real PR gates. Fixes #558 Hive-Run: #558 Hive-Plan: docs/contributing-justfile-ci-sync Hive-Spec: guide-agent-issue#558-contributing-justfile-sync Signed-off-by: hive <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.
Problem
CONTRIBUTING.md's
Justfile shortcutssection claims:This is inaccurate at main:
.github/workflows/ci.yml) runs zero of the ninevalidate:*scriptsjust buildruns. Itsvalidatejob runs onlynpm run test:unit:coverageandnpm run build:production; itslintjob runscheck:format,check:spelling,check:markdown.just builddoes not imply a green CI run: it omitstest:unit,check:format,check:spelling, andcheck:markdown, all of which gate PRs.just buildvalidators (validate:community-people,validate:community-groups,validate:launch-metrics,validate:case-studies,validate:radar-reports) run in no workflow at all.Fix
Reword the paragraph to describe what the recipes actually cover (a superset of the deploy/import workflows' data validation) and explicitly tell contributors to also run
npm run test:unitandnpm run checkto match the "Validate repository"/"Lint repository" PR gates before opening a PR.Verified
npx prettier --check,npx cspell, andnpx markdownlint-cli2all pass on the changed file.Fixes #558
— hive: backend=copilot model=gpt-5.6-luna-utility
🐝 Hive Agent:
contributor| SHA:551f833