Skip to main content
skill CX Codex

coding-principles — Claude Code skill: purpose and installation

The coding-principles Claude Code skill sets language-agnostic principles for readable, maintainable code. It activates during feature work, refactoring, and code quality reviews.

MIT ★ 720 updated 2026-11-11

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add shinpr/claude-code-workflows --skill coding-principles -a claude-code
Open on GitHub

What coding-principles does

The skill guides code changes toward simple solutions, clear names, explicit error handling, and functions with focused responsibilities. Its guidance also covers dependencies, file structure, comments, and performance.

For a change, it calls for checking both direct consumers and existing code with the same responsibility. Public signatures stay intact unless changing them is part of the accepted work. Performance tuning follows measurement of actual bottlenecks.

What it helps with

  • structure a function around one clear responsibility
  • separate data transformations from side effects
  • trace consumers of a changed public contract
  • decide whether a file or function needs splitting
  • review error handling and dependency boundaries

Example prompts for the agent

  • Implement this feature with clear names and explicit error handling.
  • Refactor this module while preserving its public signatures.
  • Review the change and trace consumers of the affected public contract.

How to install coding-principles

1Skills CLI (Vercel)

npx skills add shinpr/claude-code-workflows --skill coding-principles -a claude-code

2Manually: put the files in place

~/.claude/skills/coding-principles/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/coding-principles/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about coding-principles

How do I install coding-principles in Claude Code?

Run npx skills add shinpr/claude-code-workflows --skill coding-principles -a claude-code.

What does coding-principles do?

It gives Claude Code guidance on code structure, error handling, dependencies, comments, and performance. The skill is intended for feature implementation, refactoring, and code quality reviews.

When does Claude Code use coding-principles?

It applies during feature implementation, refactoring, or reviews of code quality.

Source text

SKILL.md · MIT
---
name: coding-principles
description: Language-agnostic coding principles for maintainability, readability, and quality. Use when implementing features, refactoring code, or reviewing code quality.
---

# Language-Agnostic Coding Principles

## Core Philosophy

1. **Maintainability over Speed**: Prioritize long-term code health over initial development velocity
2. **Simplicity First**: Choose the simplest solution that meets requirements (YAGNI principle)
3. **Design Convergence**: Deliver the current required outcome with the least new design surface. Selecting persistent state, public or cross-boundary contracts, behavioral modes, reusable abstractions, or component splits carries enough surface to justify the full convergence process first.
4. **Explicit over Implicit**: Make intentions clear through code structure and naming
5. **Delete over Comment**: Remove unused code instead of commenting it out

## Code Quality

### Continuous Improvement
- Refactor related code inside the accepted outcome and governing boundaries when it reduces the change's risk or maintenance cost
- Improve code structure incrementally
- Keep the codebase lean and focused
- Delete code proven obsolete by the requested change after checking its callers; report uncertain or out-of-scope cleanup separately

### Readability
- Use meaningful, descriptive names drawn from the problem domain
- Use full words in names; abbreviations are acceptable only when widely recognized in the domain
- Use descriptive names; single-letter names are acceptable only for loop counters or well-known conventions (i, j, x, y)
- Extract magic numbers and strings into named constants
- Keep code self-documenting where possible

## Function Design

### Parameter Management
- Group related positional parameters into an object, struct, or dictionary when call-site clarity or coordinated evolution requires it. Retain positional parameters when their order is conventional and the call remains clear, or an external/public signature requires them
- Preserve external/public signatures unless their migration is part of the accepted outcome or governing artifact

### Single Responsibility
- Each function should do one thing well
- Extract a function when independently changing responsibilities or obscured control flow make the current unit harder to understand, verify, or reuse; retain a cohesive domain flow when extraction would create artificial coupling
- Extract complex logic into separate, well-named functions
- Functions should have a single level of abstraction

### Function Organization
- Pure functions when possible (no side effects)
- Separate data transformation from side effects
- Use early returns to reduce nesting
- Use early returns or extraction when nesting obscures state transitions or decision ownership; retain nested structure when it maps the domain decision more clearly

## Error Handling

### Error Management Principles
- **Always handle errors**: Log with context or propagate explicitly
- **Log appropriately**: Include context for debugging
- **Protect sensitive data**: Mask or exclude passwords, tokens, PII from logs
- **Fail fast**: Detect and report errors as early as possible

### Error Propagation
- Use language-appropriate error handling mechanisms
- Propagate errors to appropriate handling levels
- Provide meaningful error messages
- Include error context when re-throwing

## Dependency Management

### Loose Coupling via Parameterized Dependencies
- Inject external dependencies as parameters (constructor injection for classes, function parameters for procedural/functional code)
- Depend on abstractions, not concrete implementations
- Minimize inter-module dependencies
- Facilitate testing through mockable dependencies

## Reference Representativeness

Existing code relates to a change in two ways. Code that depends on it — callers, consumers, configuration — is reached through references to the changed code. Code that already holds the same responsibility may share no name or reference with it; reach it through position and role (sibling features, files with the same role in the same layer, shared layers) and through the input it takes and the purpose it serves, then compare their logic to judge whether the responsibility is the same.

When alternatives coexist, choose the pattern from responsibility, contract, lifecycle and repository usage rather than proximity or global popularity alone. Record the evidence only when it changes the choice.

Expand to all known consumers for a changed public, shared, serialized or persistent contract whose compatibility depends on them. Stop when the candidates that could change implementation or proof have been read and judged; a search with no match shows only that the search found nothing. Resolve versions from applicable manifests and usage; record a specific limitation only when required compatibility evidence remains unavailable.

## Performance Considerations

### Optimization Approach
- **Measure first**: Profile before optimizing
- **Focus on algorithms**: Algorithmic complexity > micro-optimizations
- **Use appropriate data structures**: Choose based on access patterns
- **Resource management**: Handle memory, connections, and files properly

### When to Optimize
- After identifying actual bottlenecks through profiling
- When performance issues are measurable
- Optimize only after measurable bottlenecks are identified, not during initial development

## Code Organization

### Structural Principles
- **Group related functionality**: Keep related code together
- **Separate concerns**: Domain logic, data access, presentation
- **Consistent naming**: Follow project conventions
- **Module cohesion**: High cohesion within modules, low coupling between

### File Organization
- One primary responsibility per file
- Logical grouping of related functions/classes
- Clear folder structure reflecting architecture
- Split a file when it contains independently changing responsibilities or creates material navigation, coupling, or verification cost; retain a cohesive file when splitting would add avoidable coupling or navigation cost

## Commenting Principles

### Default: code first
Names, types, and structure are the primary medium. A comment earns its place only by carrying information the code itself cannot express. When in doubt, improve the name instead of adding a comment.

### The test for every comment
A comment is justified only if it answers one of these:
- **Why**: reasoning, trade-off, or constraint behind a non-obvious decision
- **Limitation / edge case**: a boundary a reader cannot infer from the code
- **Public API contract**: behavior, inputs, outputs of an exported interface

One comment per decision. If a comment restates what the names and control flow already show, delete it and rename instead.

### Comment Scope
- Comment the why, limits, and public contracts (per the test above); let names and structure carry everything else, including the "how"
- Record historical context in version control commit messages, not in comments
- Delete commented-out code (retrieve from git history when needed)

### Comment Quality
- Base comments on stable rationale, limits, and contracts rather than dates, versions, temporary state, or references to documents and their sections, which drift as those documents change
- Update comments when changing code
- Use proper grammar and formatting
- Write for future maintainers

## Refactoring Approach

### Safe Refactoring
- **Small steps**: Make one change at a time
- **Maintain working state**: Keep tests passing
- **Verify behavior**: Run tests after each change
- **Incremental improvement**: Make the smallest sufficient improvement in each increment

### Refactoring Triggers
- Code duplication (DRY principle)
- Functions that contain independently changing responsibilities or obscured control flow
- Complex conditional logic
- Unclear naming or structure

## Security Principles

### Secure Defaults
- Store credentials and secrets through environment variables or dedicated secret managers
- Use parameterized queries (prepared statements) for all database access
- Use established cryptographic libraries provided by the language or framework
- Generate security-critical values (tokens, IDs, nonces) with cryptographically secure random generators
- Encrypt sensitive data at rest and in transit using standard protocols

### Input and Output Boundaries
- Validate all external input at system entry points for expected format, type, and length. External input includes request data, external service responses, model or tool output, and stored data whose writer is untrusted or whose consumer needs a guarantee the store does not make
- When a change alters a boundary where external content or model output selects a tool's action, target, or destination, verify that those values cannot exceed the operation scope and access rights already granted to the caller
- Encode output appropriately for its rendering context (HTML, SQL, shell, URL)
- Return only information necessary for the caller in error responses; log detailed diagnostics server-side

### Access Control
- Apply authentication to all entry points that handle user data or trigger state changes
- Verify authorization for each resource access, not only at the entry point
- Grant only the permissions required for the operation (files, database connections, API scopes)
- For changes involving identity or protected resources, prioritize authentication and per-resource authorization review

For concrete detection patterns used by security review, see `references/security-checks.md`.

## References

- [references/frontend.md](references/frontend.md): read when implementing, reviewing, or fixing React/TypeScript code

© shinpr · MIT · shinpr/claude-code-workflows

Similar skills

All skills for Code review and refactoring →

From the same set43

The whole set →
code-verifier The code-verifier Claude Code subagent checks claims in PRDs, design docs, and work plans against repository evidence. Run it before document review, after implementation, or to verify a description of an existing system. CX Codex ★ 720repo stars scope-discoverer scope-discoverer discovers functional scope across existing codebases for reverse documentation. Groups features into PRD-ready units. CX Codex ★ 720repo stars ui-spec-designer The ui-spec-designer Claude Code subagent turns interface requirements into a specification of screens, states, and components. It activates for frontend design work or requests to break a UI into components. CX Codex ★ 720repo stars integration-test-reviewer integration-test-reviewer reviews changed integration and E2E tests to see whether they actually prove the claim behind them. Returns the gaps that matter and the smallest fix for each. CX Codex ★ 720repo stars recipe-design recipe-design is a Claude Code skill that coordinates software design from repository analysis to an approved Design Doc, pausing for user confirmation at key decisions. CX Codex +1 ★ 720repo stars code-reviewer The code-reviewer Claude Code subagent reviews completed changes against project requirements, contracts, and quality rules. It runs after implementation or when a review or compliance check is requested. CX Codex ★ 720repo stars solver solver generates distinct fixes for verified root causes and evaluates tradeoffs. Helps select the right remedy strategy once cause investigation finishes. CX Codex ★ 720repo stars design-sync design-sync compares Design Docs to flag incompatible shared requirements and returns a structured report. Use it when several design documents need a consistency check. CX Codex ★ 720repo stars

Project sponsors

Companies that keep this analytics open