Skip to content

chore: add CONTRIBUTING version guardrail check#7527

Open
Nsanjayboruds wants to merge 2 commits intolayer5io:masterfrom
Nsanjayboruds:chore/contributing-version-guardrail
Open

chore: add CONTRIBUTING version guardrail check#7527
Nsanjayboruds wants to merge 2 commits intolayer5io:masterfrom
Nsanjayboruds:chore/contributing-version-guardrail

Conversation

@Nsanjayboruds
Copy link
Contributor

This PR fixes #7520

It introduces an automated guardrail to prevent outdated dependency version references in contributor documentation.

What changed

  • Added .github/scripts/check-contributing-versions.cjs:
    • compares key version references in CONTRIBUTING.md against package.json
    • validates:
      • explicit snippets: "react": "...", "gatsby": "..."
      • prose major references like React <major> and Gatsby (<major>...)
    • exits with a clear, actionable error when mismatches are found
  • Added npm script in package.json:
    • check:contributing-versions
  • Updated CI workflow .github/workflows/checks.yml:
    • runs npm run check:contributing-versions before build
  • Refreshed stale version references in CONTRIBUTING.md to match current dependencies and wording.

Notes for Reviewers

Validation performed:

  • npm run check:contributing-versions passes locally.
  • make site was previously run successfully in this environment.
  • Pre-commit hooks passed and commit is signed.

This change is scoped to docs guardrails and CI checks; no runtime site behavior is modified.

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Nsanjayboruds <nishantborude555@gmail.com>
@l5io
Copy link
Member

l5io commented Mar 19, 2026

🚀 Preview for commit 2916336 at: https://69bb8681c74622d6c775935c--layer5.netlify.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(ci): add guardrail to prevent outdated version references in CONTRIBUTING.md

2 participants