with one click
code-quality
// Code quality principles covering comments, linter suppressions, and formatting. Use when writing or reviewing code to enforce self-documenting style, justified suppressions, and project-standard formatting.
// Code quality principles covering comments, linter suppressions, and formatting. Use when writing or reviewing code to enforce self-documenting style, justified suppressions, and project-standard formatting.
| name | code-quality |
| description | Code quality principles covering comments, linter suppressions, and formatting. Use when writing or reviewing code to enforce self-documenting style, justified suppressions, and project-standard formatting. |
Use this skill when writing or reviewing code in the narrowed Codex scope.
Use comments for:
Avoid comments that restate the code or exist only to satisfy a comment quota.
Always explain why a suppression is necessary. Prefer fixing the code instead when the warning points to a real design issue.
Examples:
// NOLINTNEXTLINE(rule-name): reason# noqa: rule-name - reason or # type: ignore[error-code] # reason//nolint:rule-name // reasonApply the project's formatter to every modified file.
clang-formatblack or project equivalentgofmt or goimportsUse references/code-review-checklist.md for the narrowed code-quality review checklist.
Use the reference docs for the detailed operating rules:
references/comments.mdreferences/linter-suppressions.mdreferences/formatting.md[HINT] Download the complete skill directory including SKILL.md and all related files