docs: strengthen agent guidance on logged-out query counts, comments, and test quality#2155
Conversation
… and test quality
|
github-actions
Bot
added
review/needs-review
@emdash-cms/admin
@emdash-cms/auth
@emdash-cms/auth-atproto
@emdash-cms/blocks
@emdash-cms/cloudflare
@emdash-cms/contentful-to-portable-text
emdash
create-emdash
@emdash-cms/gutenberg-to-portable-text
@emdash-cms/plugin-cli
@emdash-cms/plugin-types
@emdash-cms/registry-client
@emdash-cms/registry-lexicons
@emdash-cms/registry-verification
@emdash-cms/sandbox-workerd
@emdash-cms/x402
@emdash-cms/plugin-ai-moderation
@emdash-cms/plugin-atproto
@emdash-cms/plugin-audit-log
@emdash-cms/plugin-color
@emdash-cms/plugin-embeds
@emdash-cms/plugin-field-kit
@emdash-cms/plugin-forms
@emdash-cms/plugin-webhook-notifier
commit: |
![emdashbot[bot]](https://avatars.githubusercontent.com/in/3255304?s=60&v=4){kind=small}
There was a problem hiding this comment.
This is a documentation-only PR that tightens the guidance in AGENTS.md and tells the flue-review reviewer to enforce it. The three focus areas—logged-out query counts, comment discipline, and test quality—are real agent slip zones, and the changes line up with the existing Performance and Testing sections instead of inventing a new structure. I read the diff, the full changed files, and checked heading anchors and cross-references; the two new links (#performance-caching-and-query-patterns and #comments) resolve to unique headings. The changes are otherwise low-risk, but I have two small precision fixes that would make the guidance clearer and keep the reviewer prompt in sync with the new AGENTS.md content.
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s agent-facing guidance to reduce recurring quality regressions in agent-authored PRs by tightening documented rules around (1) query counts on logged-out routes, (2) comment discipline, and (3) what constitutes a meaningful test.
Changes:
- Add headline rules to AGENTS.md emphasizing that logged-out query counts must not increase without strong justification, and that comments must be evergreen and not review-thread narrative.
- Expand AGENTS.md with a dedicated Comments section and clearer test quality criteria (identifying anti-tests like config-pin/tautological/mock-the-unit tests).
- Update infra/flue-review’s review skill checklist to treat logged-out query count increases and comment/test anti-patterns as first-class findings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| infra/flue-review/.flue/skills/review/SKILL.md | Extends reviewer checklist to explicitly flag logged-out query increases, comment anti-patterns, and low-value tests. |
| AGENTS.md | Adds headline rules plus new “Comments” and “test quality” guidance; strengthens query-count snapshot expectations for logged-out routes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
github-actions
Bot
added
review/awaiting-author
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
emdash-demo-cache | 674e5af | Jul 20 2026, 08:58 PM |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
emdash-playground | 674e5af | Jul 20 2026, 08:59 PM |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
emdash-demo-do | 674e5af | Jul 20 2026, 08:59 PM |
… and test quality (emdash-cms#2155)
What does this PR do?
Strengthens the guidance agents work from (
AGENTS.md) and the conventions the flue-review reviewer checks against (infra/flue-review/.flue/skills/review/SKILL.md) in three areas where agent-authored PRs keep slipping:Type of change
Checklist
pnpm typecheckpasses — n/a, Markdown-only changepnpm lintpasses — n/a, Markdown-only changepnpm testpasses (or targeted tests for my change) — n/a, Markdown-only changepnpm formathas been run — n/a, Markdown-only changeAI-generated code disclosure
Screenshots / test output
n/a
Try this PR
Open a fresh playground →
A full working EmDash site, deployed from this branch. Each visit gets its own session-scoped sandbox: no login needed and no shared state. Try the admin, edit content, hit the public site.
Tracks
docs/agent-guidance-queries-comments-tests. Updated automatically when the playground redeploys.