software-clean-code-standard

Canonical, cross-language clean code standard with stable rule IDs (CC-*) and language overlays. Single source of truth for clean code rules; code reviews cite CC-* IDs instead of restating rules.

📖 中文导读:Canonical, cross-language clean code standard with stable rule IDs (CC-*) and language overlays. Single source of truth for clean code rules; code reviews cite CC-* IDs instead of restating rules. 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: software-clean-code-standard description: Canonical, cross-language clean code standard with stable rule IDs (CC-) and language overlays. Single source of truth for clean code rules; code reviews cite CC- IDs instead of restating rules.

Clean Code Standard — Quick Reference

This skill is the authoritative clean code standard for Claude Code Kit. It defines stable rule IDs (CC-*), how to apply them in reviews, and how to extend them safely via language overlays and explicit exceptions.

Modern Best Practices (December 2025): Prefer small, reviewable changes and durable change context (https://google.github.io/eng-practices/review/developer/small-cls.html, https://google.github.io/eng-practices/review/developer/cl-descriptions.html). Use normative language consistently (https://www.rfc-editor.org/rfc/rfc2119). Treat security-by-design and secure defaults as baseline (https://owasp.org/www-project-top-ten/, https://csrc.nist.gov/pubs/sp/800/218/final). Build observable systems (https://opentelemetry.io/docs/).


Quick Reference

Need Use Command When to Use
Cite a standard CC-* rule ID (n/a) PR review comments, design discussions, postmortems
Find the right category CC-NAM, CC-ERR, CC-SEC, etc. (n/a) Categorize feedback without “style wars”
Add stack nuance Language overlay (n/a) When the base rule is too generic for a language/framework
Allow an exception Waiver record (n/a) When a rule must be violated temporarily with explicit risk
Reuse shared checklists templates/checklists/ (n/a) When you need product-agnostic review/release checklists
Reuse utility patterns utilities/ (n/a) When extracting shared auth/logging/errors/resilience/testing utilities

When to Use This Skill

  • Defining or enforcing clean code rules across teams and languages.
  • Reviewing code: cite CC-* IDs and avoid restating standards in reviews.
  • Building automation: map linters/CI gates to CC-* IDs.
  • Resolving recurring review debates: align on rule IDs, scope, and exceptions.

Decision Tree: Base Rule vs Overlay vs Exception

Feedback needed: [What kind of guidance is this?]
    ├─ Universal, cross-language rule? → Add/modify `CC-*` in `resources/clean-code-standard.md`
    │
    ├─ Language/framework-specific nuance? → Add overlay entry referencing existing `CC-*`
    │
    └─ One-off constraint or temporary tradeoff?
        ├─ Timeboxed? → Add waiver with expiry + tracking issue
        └─ Permanent? → Propose a new rule or revise scope/exception criteria

Resources

Templates

Utilities

Related Skills


Optional: AI/Automation

  • Map automation findings to CC-* IDs (linters, SAST, dependency scanning) so humans can review impact, not tooling noise.
  • Keep AI-assisted suggestions advisory; human reviewers approve/deny with rule citations (https://conventionalcomments.org/).