Skip to content

Fix overly aggressive audit-docs comments - #592

Merged
AlexJSully merged 3 commits into
mainfrom
alexjsully-260805-overaggressive-comments
Aug 5, 2026
Merged

Fix overly aggressive audit-docs comments#592
AlexJSully merged 3 commits into
mainfrom
alexjsully-260805-overaggressive-comments

Conversation

@AlexJSully

Copy link
Copy Markdown
Owner

The audit-docs skill/prompt was overly aggressive in its comment restating the obvious multiple times through in-code comments (like stating what a var does above if statements when not relevant to the if statement).

@AlexJSully
AlexJSully requested a lite review from Copilot August 5, 2026 16:10
@AlexJSully AlexJSully self-assigned this Aug 5, 2026
@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
portfolio Ready Ready Preview Aug 5, 2026 4:58pm

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR refines the audit-docs prompt/skill guidance to avoid producing noisy in-code comments that restate obvious facts at usage sites, keeping documentation concentrated on declarations and genuinely non-obvious logic.

Changes:

  • Tightens Phase 3 (in-code documentation audit) guidance to remove restating comments and avoid repeating declaration-level facts at usage sites.
  • Extends the surface-auditor agent and the audit report template to detect and report usage-site comment duplication patterns.
  • Aligns related guidance in .github/copilot-instructions.md and typescript-code-and-test-standards to reinforce “document facts once, at the declaration”.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
.github/prompts/audit-docs.prompt.md Updates Phase 3 rules to discourage restating/duplicated in-code comments and adds a “document once at declaration” rule.
.github/copilot-instructions.md Adds “fact stated once at declaration” guidance to reduce usage-site comment repetition.
.claude/skills/typescript-code-and-test-standards/SKILL.md Adds the same “document once at declaration” guidance to the TypeScript standards skill.
.claude/skills/audit-docs/SKILL.md Mirrors the prompt’s Phase 3 updates inside the audit-docs skill.
.claude/skills/audit-docs/references/evidence-and-citation.md Adds guidance that “provable” does not imply “worth writing everywhere”.
.claude/skills/audit-docs/assets/audit-report.template.md Updates report template to include removal of repeated usage-site comments.
.claude/skills/audit-docs/agents/surface-auditor.md Expands the agent to report comments repeated above usage sites and defines output format additions.

Comment thread .claude/skills/audit-docs/SKILL.md Outdated
Comment thread .github/prompts/audit-docs.prompt.md Outdated
@AlexJSully
AlexJSully merged commit 4b81d44 into main Aug 5, 2026
2 checks passed
@AlexJSully
AlexJSully deleted the alexjsully-260805-overaggressive-comments branch August 5, 2026 17:08
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.

2 participants