From 3ecdfa7b00d24db1537f886d4d10a83a469854c9 Mon Sep 17 00:00:00 2001 From: mrbobbytables Date: Thu, 24 Sep 2026 13:20:25 +0000 Subject: [PATCH] docs: add Lint repository CI check step to Making changes CONTRIBUTING.md's 'Making changes' section told contributors to run test:unit and build but never mentioned the 'Lint repository' CI job (check:format, check:spelling, check:markdown), so a first-time contributor could pass every documented step and still fail CI on lint. Add a step covering npm run check and how to fix each failure class. Hive-Run: cncf/endusers#569 Hive-Plan: docs-contributing-lint-checks Hive-Spec: contributing-guide#making-changes-lint-step Signed-off-by: mrbobbytables --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2ec68a2..e15769b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -141,11 +141,20 @@ enough for a first contribution. 3. Run `npm run test:unit` — the required "Validate repository" check runs this on every PR. 4. Verify with `npm run build` before opening a PR. -5. Commit with a DCO sign-off: `git commit -s`. CI enforces this and will fail +5. Run `npm run check` — the required "Lint repository" check runs this on every + PR. It covers `check:format` (prettier), `check:spelling` (cspell), and + `check:markdown` (markdownlint), and you can also run any of the three + individually. If a check fails: + - `check:format` — run `npm run fix:format` to auto-format. + - `check:spelling` — add the flagged term to `.cspell.yml` if it's a + legitimate project word, or fix the typo. + - `check:markdown` — fix the reported issue, or add an inline disable comment + per the rules in `.markdownlint.yaml` if the rule doesn't apply. +6. Commit with a DCO sign-off: `git commit -s`. CI enforces this and will fail the PR if any commit is missing a `Signed-off-by` trailer. If you forget, fix it before pushing (or after, then force-push) with `git rebase --signoff main`. -6. Open a pull request against `main` describing what changed and why. +7. Open a pull request against `main` describing what changed and why. ## Agent contributors