Agent skill
coding-standards
Core coding principles and design aphorisms for writing maintainable code. Use when writing, reviewing, or refactoring code. Use it anytime you need to write code.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/coding-standards-finimo-solutions-research
Metadata
Additional technical details for this skill
- author
- latitude
- version
- 1.0.0
SKILL.md
Coding Standards
Principles for writing maintainable, debuggable code that stands the test of time.
When to Apply
Reference these guidelines when:
- Writing new code or reviewing pull requests
- Debugging issues caused by unclear data flow
- Designing APIs, method signatures, or data structures
- Refactoring code for maintainability
- Deciding how to handle errors and edge cases
- Managing state in applications
Principles at a Glance
| Principle | Core Idea | Key Rule |
|---|---|---|
| Nil Values | Null means absence, nothing else | Never give semantic meaning to null |
| Grep Test | Code must be findable | If you can't grep it, it's too clever |
| Data First | Structure determines code | Design data structures before algorithms |
| Stable Dependencies | Depend on what's stable | Depend on abstractions, not implementations |
| Loud Failures | Hidden bugs are worse | If it can fail, make it fail loudly |
| Tell, Don't Ask | Objects own their behavior | Don't query state to make external decisions |
| Avoid Dichotomies | Reality is nuanced | Reject false binary choices |
| Single Source of Truth | State lives in one place | Never derive state from state |
| Explicit Parameters | Clarity over cleverness | Avoid booleans and hashes as arguments |
| Task Parameters | Fresh data in async code | Pass IDs to tasks, not models |
Quick Reference
Null Handling
Bad: Using null to signal a semantic condition
const role = ROLES[user.role] // Returns undefined if not found
processRole(role) // Explodes somewhere far away
Good: Validate at boundaries, use explicit types
const role = ROLES[user.role]
if (!role) throw new Error(`Unknown role: ${user.role}`)
processRole(role)
Findable Code
Bad: Dynamic method dispatch
const method = `handle${eventType}`
this[method](data) // Good luck finding handleUserCreated
Good: Explicit mapping
const handlers = {
userCreated: this.handleUserCreated,
userDeleted: this.handleUserDeleted,
}
handlers[eventType]?.(data)
Dependency Direction
Bad: Concrete depends on concrete
class PaymentService {
private stripe = new StripeClient() // Locked to Stripe forever
}
Good: Depend on abstractions
class PaymentService {
constructor(private gateway: PaymentGateway) {} // Any gateway works
}
Error Handling
Bad: Silent failures
try {
await saveUser(user)
} catch (e) {
// Swallowed silently
}
Good: Fail loudly or handle explicitly
const result = await saveUser(user)
if (result.error) {
captureException(result.error)
throw result.error
}
Tell, Don't Ask
Bad: Query state, then act
if (monitor.getValue() > monitor.getLimit()) {
monitor.triggerAlarm()
}
Good: Let the object decide
monitor.setValue(newValue) // Triggers alarm internally if needed
State Management
Bad: Derived state
const [items, setItems] = useState(props.items) // Copied from props
Good: Single source of truth
const items = props.items // Always read from source
Method Signatures
Bad: Boolean parameter
viewController.present(other, true) // What does true mean?
Good: Explicit methods
viewController.animatePresentation(other)
viewController.immediatelyPresent(other)
Async Tasks
Bad: Passing models to queues
queue.add('processUser', { user }) // Stale by execution time
Good: Pass identifiers
queue.add('processUser', { userId: user.id }) // Fetch fresh data in job
Detailed Guide
Read the GUIDE.md file for comprehensive explanations, rationale, and additional examples for each principle.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?