Skip to content

docs(guides): document the CODING_STANDARDS.md criteria file - #1573

Merged
tmchow merged 1 commit into
mainfrom
tmchow/ce-code-review-guide-standards-file
Aug 28, 2026
Merged

docs(guides): document the CODING_STANDARDS.md criteria file#1573
tmchow merged 1 commit into
mainfrom
tmchow/ce-code-review-guide-standards-file

Conversation

@tmchow

@tmchow tmchow commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

ce-code-review's guide never mentioned that the review is customizable. #1572 shipped CODING_STANDARDS.md as the criteria source, but the docs went out unchanged, so a reader had no way to discover the feature — the page said only that project-standards runs "when applicable standards files exist," which stayed technically true and explained nothing.

The new Repo-owned review criteria section covers what someone actually needs in order to write one: where to put the file and what it governs, that any format works (prose, bullets, tables — no schema, no identifiers), that it takes precedence over CLAUDE.md / AGENTS.md per changed file so existing repos keep the review they had, and why enforceable rules belong there rather than in an instruction file that is charged to every agent turn.

The intro, a TL;DR row, the persona-selection bullet, the FAQ answer, and the catalog row in docs/guides/README.md now point at it. Docs only — no skill or source behavior changes.

Validation

bun run release:validate reports metadata in sync; tests/release-metadata.test.ts passes 44/0. Both new anchor links resolve to the added heading, and no "applicable standards file" phrasing remains. No skill counts changed — this adds no skill, so the root README.md needs nothing.

Security Disclosure

No security-relevant changes. Documentation prose only, in docs/guides/, which #1571 moved out of the plugin skills tree — nothing here ships as runtime agent instruction.

Agent Disclosure

  • Model: Claude Code · claude-opus-5[1m]

The capability shipped in #1572 without reaching the guide, so nothing told a
reader that review is customizable or that the file exists. The guide said only
that project-standards runs "when applicable standards files exist", which stayed
true and explained nothing.

Adds a "Repo-owned review criteria" section covering what a reader needs to write
one: placement scopes it, any format works, it takes precedence over the
instruction file per changed file, and it can grow because it is read at review
time rather than charged to every agent turn. The intro, a TL;DR row, the
persona-selection bullet, the FAQ answer, and the catalog row now point at it.
@cursor

cursor Bot commented Aug 28, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only updates in docs/guides/; no runtime, auth, or skill behavior changes.

Overview
Documents repo-owned review criteria for /ce-code-review, which shipped in code but was not described in the guides.

The ce-code-review guide now explains that teams can add CODING_STANDARDS.md (scoped by path, any prose/bullet format) so the project-standards persona enforces those rules with cited findings, and how that replaces CLAUDE.md / AGENTS.md as criteria per changed file when a standards file governs that path. The intro, TL;DR “How to customize it” row, persona-selection bullet, and FAQ are updated to point at the new section instead of vague “applicable standards files” wording.

The on-demand skills table in docs/guides/README.md now mentions CODING_STANDARDS.md in the /ce-code-review blurb. Docs only — no skill or runtime behavior changes.

Reviewed by Cursor Bugbot for commit 2c0f81b. Bugbot is set up for automated code reviews on this repo. Configure here.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-28T21:48:08.322502Z 2c0f81b PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

{"findings":[]}

Open in Web View Automation 

Sent by Cursor Security Agent: Security Reviewer

@tmchow
tmchow merged commit cbd3291 into main Aug 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant