# 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. - Skill: `majiayu000/software-clean-code-standard-2` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds add majiayu000/software-clean-code-standard-2` - Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/software-clean-code-standard-2/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Coding & Dev Tools - Author: majiayu000 (https://skillmd.com/u/majiayu000) - Updated: 2026-09-09 - Page: https://skillmd.com/skills/majiayu000/software-clean-code-standard-2 --- # 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 ```text 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 ``` --- ## Navigation **Resources** - [resources/clean-code-standard.md](resources/clean-code-standard.md) - [resources/code-quality-operational-playbook.md](resources/code-quality-operational-playbook.md) — Legacy operational playbook (RULE-01–RULE-13) - [resources/clean-code-operational-checklist.md](resources/clean-code-operational-checklist.md) - [resources/clean-coder-operational-checklist.md](resources/clean-coder-operational-checklist.md) - [resources/code-complete-operational-checklist.md](resources/code-complete-operational-checklist.md) - [resources/pragmatic-programmer-operational-checklist.md](resources/pragmatic-programmer-operational-checklist.md) - [resources/practice-of-programming-operational-checklist.md](resources/practice-of-programming-operational-checklist.md) - [resources/working-effectively-with-legacy-code-operational-checklist.md](resources/working-effectively-with-legacy-code-operational-checklist.md) - [resources/art-of-clean-code-operational-checklist.md](resources/art-of-clean-code-operational-checklist.md) - [resources/refactoring-operational-checklist.md](resources/refactoring-operational-checklist.md) - [resources/design-patterns-operational-checklist.md](resources/design-patterns-operational-checklist.md) - [data/sources.json](data/sources.json) — Durable external references for review, security-by-design, and observability - [CONVENTIONS.md](CONVENTIONS.md) — Skill structure and validation conventions - [SKILL-TEMPLATE.md](SKILL-TEMPLATE.md) — Copy-paste starter for new skills - [sources-schema.json](sources-schema.json) — JSON schema for `data/sources.json` - [skill-dependencies.json](skill-dependencies.json) — Related-skills dependency graph **Templates** - [templates/checklists/backend-api-review-checklist.md](templates/checklists/backend-api-review-checklist.md) - [templates/checklists/secure-code-review-checklist.md](templates/checklists/secure-code-review-checklist.md) - [templates/checklists/frontend-performance-a11y-checklist.md](templates/checklists/frontend-performance-a11y-checklist.md) - [templates/checklists/mobile-release-checklist.md](templates/checklists/mobile-release-checklist.md) - [templates/checklists/ux-design-review-checklist.md](templates/checklists/ux-design-review-checklist.md) - [templates/checklists/ux-research-plan-template.md](templates/checklists/ux-research-plan-template.md) **Utilities** - [utilities/README.md](utilities/README.md) - [utilities/auth-utilities.md](utilities/auth-utilities.md) - [utilities/error-handling.md](utilities/error-handling.md) - [utilities/config-validation.md](utilities/config-validation.md) - [utilities/resilience-utilities.md](utilities/resilience-utilities.md) - [utilities/logging-utilities.md](utilities/logging-utilities.md) - [utilities/observability-utilities.md](utilities/observability-utilities.md) - [utilities/testing-utilities.md](utilities/testing-utilities.md) - [utilities/llm-utilities.md](utilities/llm-utilities.md) **Related Skills** - [../software-code-review/SKILL.md](../software-code-review/SKILL.md) — Review workflow and judgment; cite `CC-*` IDs - [../software-security-appsec/SKILL.md](../software-security-appsec/SKILL.md) — Security deep dives beyond baseline `CC-SEC-*` - [../qa-refactoring/SKILL.md](../qa-refactoring/SKILL.md) — Refactoring execution patterns and quality gates - [../software-architecture-design/SKILL.md](../software-architecture-design/SKILL.md) — System-level tradeoffs and boundaries --- ## 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/).