Coding Standards
D9 Canonical Reference. This is the single source of truth for cross-language coding standards.
Language-specific reviewers (@typescript-reviewer, @python-reviewer, etc.) embed these rules.
Agents cite this skill as "See also: /coding-standards."
Naming Conventions
Variables & Functions
| Language |
Variables |
Functions |
Constants |
| TypeScript / JavaScript |
camelCase |
camelCase |
SCREAMING_SNAKE_CASE |
| Python |
snake_case |
snake_case |
SCREAMING_SNAKE_CASE |
| Go |
camelCase |
camelCase |
CamelCase (exported) |
| Rust |
snake_case |
snake_case |
SCREAMING_SNAKE_CASE |
| Java |
camelCase |
camelCase |
SCREAMING_SNAKE_CASE |
| C# |
camelCase |
PascalCase |
PascalCase |
| Swift |
camelCase |
camelCase |
camelCase |
Classes / Types / Interfaces
PascalCase — all languages, no exceptions.
Booleans
Prefix with is, has, can, should: isLoading, hasError, canEdit, shouldRefresh.
Collections
Plural nouns: users, errors, items — not userList, errorArray.
Avoid
- Single-letter variables outside loop counters (
i, j, k are OK in loops)
- Abbreviations that save under 3 characters:
usr → user, mgr → manager
- Redundant type names:
UserInterface, UserClass, UserObject → just User
Function Design
- Max length: 50 lines (firm guideline; > 80 lines is always a split target)
- Single responsibility: one function, one job — if "and" appears in the description, split it
- Max parameters: 3; beyond that, use an options/config object
- Cyclomatic complexity: ≤ 10; > 15 is a mandatory refactor target
- Nesting depth: ≤ 3 levels; use early returns to flatten
Early Return Pattern (preferred)
// BEFORE — deep nesting
function handle(input) {
if (input) {
if (input.valid) {
return process(input);
}
}
return null;
}
// AFTER — early returns
function handle(input) {
if (!input || !input.valid) return null;
return process(input);
}
Error Handling
- Never swallow errors silently:
catch (e) {} is always wrong
- Error messages must contain context:
"Failed to fetch user id=42" not "Error"
- Propagate or handle: either handle the error at the right level OR re-throw it — never both and never neither
- Typed errors (TypeScript):
class NotFoundError extends Error { constructor(id: string) ... } not generic new Error
- Python exceptions: catch specific exception types; bare
except: is forbidden
- Go errors: always check returned errors; use
errors.Is()/errors.As() for comparison
- Rust results: use
? for propagation; no .unwrap() in library code
Code Structure
Immutability-First
const over let (JS/TS); val over var (Swift/Kotlin); final where appropriate
- Mark fields
readonly when not reassigned after construction
- Prefer immutable data structures for function arguments
No Magic Numbers
// BAD
if (retries > 3) { ... }
setTimeout(fn, 5000);
// GOOD
const MAX_RETRIES = 3;
const POLL_INTERVAL_MS = 5000;
if (retries > MAX_RETRIES) { ... }
setTimeout(fn, POLL_INTERVAL_MS);
No Commented-Out Code
If it is dead → delete it (git history preserves it).
If it is needed soon → it should be in a branch.
If it explains a non-obvious decision → keep it as a comment, not commented-out code.
Anti-Patterns Reference
| Pattern |
Severity |
Reason |
| Mutable global state |
HIGH |
Unpredictable side effects; hides dependencies |
| Promise not awaited |
HIGH |
Unhandled async errors silently swallowed |
any in TypeScript |
MEDIUM |
Bypasses type safety across call boundaries |
console.log in production code |
LOW |
Log noise; potential data leak in sensitive contexts |
TODO without issue tracker reference |
LOW |
Becomes permanent tech debt |
| God Object |
HIGH |
Single class with too many responsibilities |
| Magic numbers inline |
MEDIUM |
Unclear intent; maintenance hazard |
| Copy-paste logic |
MEDIUM |
Silent divergence over time |
| Catching and re-throwing without context |
MEDIUM |
Stack traces lose meaning |
| Nested ternary operators |
MEDIUM |
Unreadable; use if/else or switch instead |
SOLID Principles Checklist
- Single Responsibility: does this class/function do exactly one thing?
- Open/Closed: extend via composition/interfaces, not inheritance modification?
- Liskov Substitution: can a subtype always replace the base type without breaking callers?
- Interface Segregation: no fat interfaces — clients should not depend on methods they don't use?
- Dependency Inversion: depend on abstractions (interfaces), not concretions?
See Also
@code-reviewer — applies these rules during code review
@typescript-reviewer, @python-reviewer, etc. — language-specific rules with these as baseline
@security-reviewer — security-specific standards (OWASP, secrets, crypto)
1---
2name: coding-standards
3description: >
4 Canonical cross-language coding standards reference. Shared rules embedded by reviewer agents.
5 Activate when: viewing coding standards, checking naming rules, reviewing style baseline,
6 consulting style guide, what are the rules.
7argument-hint: "[optional: specific topic — naming | functions | errors | anti-patterns]"
8metadata:
9 source: https://skillmd.com/skills/zereight/coding-standards
10---
11
12# Coding Standards
13
14> **D9 Canonical Reference.** This is the single source of truth for cross-language coding standards.
15> Language-specific reviewers (`@typescript-reviewer`, `@python-reviewer`, etc.) embed these rules.
16> Agents cite this skill as "See also: /coding-standards."
17
18## Naming Conventions
19
20### Variables & Functions
21| Language | Variables | Functions | Constants |
22|----------|-----------|-----------|-----------|
23| TypeScript / JavaScript | `camelCase` | `camelCase` | `SCREAMING_SNAKE_CASE` |
24| Python | `snake_case` | `snake_case` | `SCREAMING_SNAKE_CASE` |
25| Go | `camelCase` | `camelCase` | `CamelCase` (exported) |
26| Rust | `snake_case` | `snake_case` | `SCREAMING_SNAKE_CASE` |
27| Java | `camelCase` | `camelCase` | `SCREAMING_SNAKE_CASE` |
28| C# | `camelCase` | `PascalCase` | `PascalCase` |
29| Swift | `camelCase` | `camelCase` | `camelCase` |
30
31### Classes / Types / Interfaces
32`PascalCase` — all languages, no exceptions.
33
34### Booleans
35Prefix with `is`, `has`, `can`, `should`: `isLoading`, `hasError`, `canEdit`, `shouldRefresh`.
36
37### Collections
38Plural nouns: `users`, `errors`, `items` — not `userList`, `errorArray`.
39
40### Avoid
41- Single-letter variables outside loop counters (`i`, `j`, `k` are OK in loops)
42- Abbreviations that save under 3 characters: `usr` → `user`, `mgr` → `manager`
43- Redundant type names: `UserInterface`, `UserClass`, `UserObject` → just `User`
44
45---
46
47## Function Design
48
49- **Max length:** 50 lines (firm guideline; > 80 lines is always a split target)
50- **Single responsibility:** one function, one job — if "and" appears in the description, split it
51- **Max parameters:** 3; beyond that, use an options/config object
52- **Cyclomatic complexity:** ≤ 10; > 15 is a mandatory refactor target
53- **Nesting depth:** ≤ 3 levels; use early returns to flatten
54
55### Early Return Pattern (preferred)
56```typescript
57// BEFORE — deep nesting
58function handle(input) {
59 if (input) {
60 if (input.valid) {
61 return process(input);
62 }
63 }
64 return null;
65}
66
67// AFTER — early returns
68function handle(input) {
69 if (!input || !input.valid) return null;
70 return process(input);
71}
72```
73
74---
75
76## Error Handling
77
78- **Never swallow errors silently:** `catch (e) {}` is always wrong
79- **Error messages must contain context:** `"Failed to fetch user id=42"` not `"Error"`
80- **Propagate or handle:** either handle the error at the right level OR re-throw it — never both and never neither
81- **Typed errors (TypeScript):** `class NotFoundError extends Error { constructor(id: string) ... }` not generic `new Error`
82- **Python exceptions:** catch specific exception types; bare `except:` is forbidden
83- **Go errors:** always check returned errors; use `errors.Is()`/`errors.As()` for comparison
84- **Rust results:** use `?` for propagation; no `.unwrap()` in library code
85
86---
87
88## Code Structure
89
90### Immutability-First
91- `const` over `let` (JS/TS); `val` over `var` (Swift/Kotlin); `final` where appropriate
92- Mark fields `readonly` when not reassigned after construction
93- Prefer immutable data structures for function arguments
94
95### No Magic Numbers
96```typescript
97// BAD
98if (retries > 3) { ... }
99setTimeout(fn, 5000);
100
101// GOOD
102const MAX_RETRIES = 3;
103const POLL_INTERVAL_MS = 5000;
104if (retries > MAX_RETRIES) { ... }
105setTimeout(fn, POLL_INTERVAL_MS);
106```
107
108### No Commented-Out Code
109If it is dead → delete it (git history preserves it).
110If it is needed soon → it should be in a branch.
111If it explains a non-obvious decision → keep it as a comment, not commented-out code.
112
113---
114
115## Anti-Patterns Reference
116
117| Pattern | Severity | Reason |
118|---------|----------|--------|
119| Mutable global state | HIGH | Unpredictable side effects; hides dependencies |
120| Promise not awaited | HIGH | Unhandled async errors silently swallowed |
121| `any` in TypeScript | MEDIUM | Bypasses type safety across call boundaries |
122| `console.log` in production code | LOW | Log noise; potential data leak in sensitive contexts |
123| `TODO` without issue tracker reference | LOW | Becomes permanent tech debt |
124| God Object | HIGH | Single class with too many responsibilities |
125| Magic numbers inline | MEDIUM | Unclear intent; maintenance hazard |
126| Copy-paste logic | MEDIUM | Silent divergence over time |
127| Catching and re-throwing without context | MEDIUM | Stack traces lose meaning |
128| Nested ternary operators | MEDIUM | Unreadable; use if/else or switch instead |
129
130---
131
132## SOLID Principles Checklist
133
134- **S**ingle Responsibility: does this class/function do exactly one thing?
135- **O**pen/Closed: extend via composition/interfaces, not inheritance modification?
136- **L**iskov Substitution: can a subtype always replace the base type without breaking callers?
137- **I**nterface Segregation: no fat interfaces — clients should not depend on methods they don't use?
138- **D**ependency Inversion: depend on abstractions (interfaces), not concretions?
139
140---
141
142## See Also
143
144- `@code-reviewer` — applies these rules during code review
145- `@typescript-reviewer`, `@python-reviewer`, etc. — language-specific rules with these as baseline
146- `@security-reviewer` — security-specific standards (OWASP, secrets, crypto)