Fix overly aggressive audit-docs comments - #592
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
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-auditoragent and the audit report template to detect and report usage-site comment duplication patterns. - Aligns related guidance in
.github/copilot-instructions.mdandtypescript-code-and-test-standardsto 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
audit-docsskill/prompt was overly aggressive in its comment restating the obvious multiple times through in-code comments (like stating what a var does aboveifstatements when not relevant to theifstatement).