From 5132a02a78f66fb89a9dc4ab781ec40c78c4f487 Mon Sep 17 00:00:00 2001 From: sec-check Date: Thu, 24 Sep 2026 19:56:11 -0400 Subject: [PATCH] [guide] docs: add pre-PR validation checklist to CONTRIBUTING Signed-off-by: sec-check --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df06c27..4e57c1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,3 +9,20 @@ Thank you for helping improve the Hive Commons documentation site - Site code, navigation, and layout changes belong in this repository. - Sign your commits with the DCO: `git commit -s`. - Open an issue at https://github.com/hivecommons/docs/issues for anything unclear. + +## Before you open a PR + +CI runs these checks on every PR; run them locally first so you catch +failures before pushing: + +```bash +npm run lint:md # markdownlint-cli2 on README, CONTRIBUTING, and docs content +npm run type-check # tsc --noEmit +npm test # vitest run +npm run check-links # validates internal doc links +npm run lint # eslint on src/ +``` + +`npm run build` also exercises the doc-sync scripts (`sync-hive-docs`, +`sync-sibling-docs`) and is worth running if you changed anything under +`scripts/`.