Skip to content

docs(contributing): list the three CI-enforced gates the manual gate omitted#1373

Merged
JSONbored merged 4 commits into
JSONbored:mainfrom
kiannidev:docs/issue-1372-required-gates
Jun 26, 2026
Merged

docs(contributing): list the three CI-enforced gates the manual gate omitted#1373
JSONbored merged 4 commits into
JSONbored:mainfrom
kiannidev:docs/issue-1372-required-gates

Conversation

@kiannidev

Copy link
Copy Markdown
Contributor

Summary

The Required Gates code block in CONTRIBUTING.md is meant to mirror the combined gate (npm run test:ci), but it omitted three commands that test:ci runs and that CI enforces. A contributor who followed the documented gate literally would skip them and could still hit CI failures. This adds the missing commands in the same order they appear in test:ci.

Added:

Command Enforced by (.github/workflows/ci.yml)
npm run db:migrations:check lint job — "Check migrations" step
npm run ui:version-audit ui job — "UI/MCP version audit" step
npm run ui:test ui job — "UI tests" step

After this change the documented gate matches the 14-step test:ci script in package.json (plus the trailing npm audit, as before).

Why no screenshots

Docs-only change to a single Markdown file; there is no visible UI, frontend, or extension surface to capture.

Validation

git diff --check

Docs-only change: it touches only CONTRIBUTING.md (no path matched by the CI backend/ui/mcp filters), so the code/test/build gates are not applicable to this diff. The whitespace gate (git diff --check) passes with no errors.

Linked issue

Fixes #1372

Made with Cursor

…omitted

The Required Gates command block is meant to mirror the combined gate
(npm run test:ci), but it left out three commands that test:ci runs and that
CI enforces, so contributors who followed it could still hit CI failures:

- npm run db:migrations:check (CI lint job)
- npm run ui:version-audit (CI ui job)
- npm run ui:test (CI ui job)

Add them in the same order as test:ci so the documented gate matches the
actually enforced gate.

Fixes JSONbored#1372

Co-authored-by: Cursor <cursoragent@cursor.com>
@kiannidev kiannidev requested a review from JSONbored as a code owner June 25, 2026 14:06
@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jun 25, 2026
@superagent-security

Copy link
Copy Markdown

Superagent didn't find any vulnerabilities or security issues in this PR.

@JSONbored JSONbored left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First-filed and factually correct against test:ci and ci.yml. The doc now mirrors CI. Merge. For the record: an identical copy ([#1378 (https://github.com//issues/1378)) was filed ~2h later on the same issue by a different account — that one's the problem, not this.

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

Labels

lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(contributing): Required Gates list omits three CI-enforced commands

2 participants