Stop audit-docs skill from deleting minimal public export comments - #607
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Two instructions regress or diverge from the repository’s canonical comment and prompt-parity rules.
Review effort: Balanced
Findings: 2
Open (2)
What changed in this PR
Adds a one-sentence floor preventing documentation audits from deleting minimal public API comments and propagates the rule across agent guidance.
Changes:
- Preserves minimal public/exported documentation comments.
- Clarifies declaration, usage-site, and comment-removal rules.
- Updates audit templates and validation checklists.
| File | Description |
|---|---|
CLAUDE.md |
Updates repository comment guidance. |
.github/prompts/audit-docs.prompt.md |
Revises the standalone documentation audit. |
.github/copilot-instructions.md |
Synchronizes Copilot comment rules. |
.claude/skills/typescript-code-and-test-standards/SKILL.md |
Adds the public-comment floor. |
.claude/skills/typescript-code-and-test-standards/references/comments-and-jsdoc.md |
Documents preservation behaviour. |
.claude/skills/typescript-code-and-test-standards/assets/copilot-instructions.template.md |
Updates generated guidance. |
.claude/skills/typescript-code-and-test-standards/agents/comment-and-jsdoc-auditor.md |
Revises audit findings. |
.claude/skills/audit-docs/SKILL.md |
Implements the new audit rule. |
.claude/skills/audit-docs/references/voice-and-ai-tells.md |
Updates public-comment examples. |
.claude/skills/audit-docs/references/evidence-and-citation.md |
Clarifies absence-claim evidence. |
.claude/skills/audit-docs/assets/audit-report.template.md |
Adds preservation reporting checks. |
.claude/skills/audit-docs/agents/surface-auditor.md |
Requires a non-empty public-comment floor. |
.claude/rules/docs-authoring.md |
Synchronizes documentation rules. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch was successfully deployed
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 was deleting one-line public exports comments. Fixed it to stop doing that here.