docs: make the documented verification loop match what CI runs - #644
Open
ayobamiseun wants to merge 1 commit into
Open
ayobamiseun wants to merge 1 commit into
ayobamiseun wants to merge 1 commit into
Conversation
docs/developer-onboarding.md promises that everything CI runs can be run locally, then lists three validators, the eval runner and one hook test. CI runs six validators, seven unit-test files and three hook suites on three operating systems, so a contributor following the doc can fail several steps they never ran. The Tier 1 row in evals/README.md names two validators where there are five, and Tier 2 omits the rank-1 floor. List every workflow command in the onboarding block in workflow order, note the PowerShell glob caveat, state the cross-platform leg, name the workflow file as the source of truth, and align Path 3 and the pre-PR checklist. Update both tier rows in evals/README.md. CLAUDE.md's stale line is left for later because addyosmani#548 edits that file. Every command in the new block was run from this branch and passes, and every command in the workflow appears in the block.
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.
Summary
docs/developer-onboarding.mdpromises "everything CI runs, you can run locally", then lists three validators, the eval runner, and one hook test. CI today runs six validators, seven unit-test files, and three hook suites, on three operating systems. A contributor who follows §3 to the letter can open a PR that fails the reference-link, artifact-path, or manifest-version step, or any unit test, without having run them.The tier table in
evals/README.mdhas the same drift: Tier 1 names two validators where there are now five, and Tier 2 omits the--min-rank1 95floor that CI actually enforces.Change
docs/developer-onboarding.mdscripts/changes need the unit tests, command-directory changes need both parity and artifact-path checks.evals/README.md: Tier 1 row lists what is checked and the five validators; Tier 2 row shows the--min-rank1 95invocation.CLAUDE.mdhas the same stale one-liner but is left alone here because #548 edits that file.Verification
Every command in the new block was run from this branch and passes:
And the reverse check: every
node scripts/…,node --test …, andbash hooks/…command in.github/workflows/test-plugin-install.ymlappears in the new block (unit-test files via the glob). Docs only; no behaviour changes.