From 551f8330498d551c52d6c926c7cad8b6e2650986 Mon Sep 17 00:00:00 2001 From: hive Date: Thu, 24 Sep 2026 13:03:54 +0000 Subject: [PATCH] docs: fix CONTRIBUTING.md Justfile/CI sync claim 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: cncf/endusers#558 Hive-Plan: docs/contributing-justfile-ci-sync Hive-Spec: guide-agent-issue#558-contributing-justfile-sync Signed-off-by: hive --- CONTRIBUTING.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2ec68a2..42da5d98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,19 +24,22 @@ If you have [`just`](https://github.com/casey/just) installed, the repository's `Justfile` provides shortcuts that wrap the npm scripts above: - `just serve` — start the dev server bound to all interfaces. -- `just import` — import reference architectures and run the same validation - steps as the import workflow (`import:architectures`, - `validate:architectures`, `validate:architecture-assets`). -- `just build` — run the same validation steps as CI (`validate:architectures`, +- `just import` — import reference architectures and run `import:architectures`, + `validate:architectures`, and `validate:architecture-assets`. +- `just build` — run the data validators (`validate:architectures`, `validate:architecture-assets`, `validate:metrics`, `validate:awards`, `validate:community-people`, `validate:community-groups`, `validate:launch-metrics`, `validate:case-studies`, `validate:radar-reports`) followed by `build`. -These recipes are kept in sync with the checks the "Validate repository" and -"Import reference architectures" workflows run, so a green -`just build`/`just import` locally should also pass in CI. `just` is optional — -the npm scripts remain the canonical interface and work without it. +These recipes are a superset of the validation steps the "Deploy to GitHub +Pages" and "Import reference architectures" workflows run, but they are **not** +the same checks the "Validate repository" and "Lint repository" PR gates run, +and a green `just build`/`just import` locally does **not** imply a green PR +check. Before opening a PR, also run `npm run test:unit` and `npm run check` (or +the individual `check:format`, `check:spelling`, and `check:markdown` scripts) +to match what "Validate repository" and "Lint repository" check. `just` is +optional — the npm scripts remain the canonical interface and work without it. ## Content audience