Skip to content

docs: accurately describe CI and PR-only checks - #245

Closed
jdotc1 wants to merge 1 commit into
TMHSDigital:mainfrom
jdotc1:docs/ci-check-steps-240
Closed

jdotc1 wants to merge 1 commit into
TMHSDigital:mainfrom
jdotc1:docs/ci-check-steps-240

Conversation

@jdotc1

@jdotc1 jdotc1 commented Nov 6, 2026

Copy link
Copy Markdown

Summary

  • Correct the documented npm run check command to match the script it actually runs.
  • Describe the test, validation, added-asset validation, and build stages individually in the README, site README, and contributor guide.
  • Clarify that licence-diff reporting is a separate pull-request workflow step, not part of npm run check.

Fixes #240.

Verification

  • npm run check (all checks passed)
  • npm run check-added against complete git history (421 entries, passed)
  • git diff --check (passed)

No source or workflow behavior changes.

@TMHSDigital

Copy link
Copy Markdown
Owner

Thank you for picking this up. #240 was fixed on main in d1aaa03 while this was open: CONTRIBUTING.md now has a "What CI runs" section listing each step of npm run check (which also gained a lint step), the full-history need of check-added, and the PR-only licence-field summary from site/pr-diff.mjs; the README, site/README.md and the PR template link to it. Since CI now runs npm run check itself rather than an equivalent, this branch is out of date and conflicts with main, so I'm closing it as superseded.

@TMHSDigital TMHSDigital closed this Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs describe "what CI runs" three ways and none mention check-added or the PR licence diff

2 participants