The audit-docs skill deleting private comments - #608
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
Conflicting rationale and closed-delete-list rules can still produce inconsistent comment deletion.
Review effort: Balanced
Findings: 10
Open (10)
What changed in this PR
Updates comment-auditing guidance to preserve private comments unless narrow deletion criteria apply.
Changes:
- Adds retention rules and examples across audit skills and repository guidance.
- Aligns PR review guidance with correcting rather than deleting comments.
- Refreshes development dependencies and the lockfile.
| File | Description |
|---|---|
package.json |
Upgrades development tooling. |
package-lock.json |
Resolves upgraded dependencies. |
CLAUDE.md |
Revises comment-retention guidance. |
.github/prompts/audit-pr.prompt.md |
Updates comment-review criteria. |
.github/prompts/audit-docs.prompt.md |
Adds restricted deletion rules. |
.github/copilot-instructions.md |
Preserves private and rationale comments. |
.claude/skills/typescript-code-and-test-standards/SKILL.md |
Refines comment standards. |
.claude/skills/typescript-code-and-test-standards/references/comments-and-jsdoc.md |
Expands comment examples. |
.claude/skills/typescript-code-and-test-standards/assets/copilot-instructions.template.md |
Updates reusable guidance. |
.claude/skills/typescript-code-and-test-standards/agents/comment-and-jsdoc-auditor.md |
Revises auditor rules. |
.claude/skills/audit-pr/references/review-categories.md |
Updates documentation-review guidance. |
.claude/skills/audit-docs/SKILL.md |
Defines ordered comment handling. |
.claude/skills/audit-docs/references/existing-comments.md |
Adds worked examples. |
.claude/skills/audit-docs/assets/audit-report.template.md |
Updates reporting outcomes. |
.claude/skills/audit-docs/agents/surface-auditor.md |
Refines comment findings. |
.claude/rules/docs-authoring.md |
Aligns 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 overzealous in deleting private comments. Fixed that.