Skip to content

Commit d28ce00

Browse files
committed
feat(claude): add claude/CLAUDE.md, which will link to ~/.claude
1 parent 2f18702 commit d28ce00

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

claude/CLAUDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Be extremely concise. Sacrifice grammar for the sake of concision.
2+
3+
## Coding Patterns and Best Practices (Typescript)
4+
5+
- Prefer single object parameters (improves backwards-compatibility)
6+
- Prefer types over interfaces (except when extending external types)
7+
- Prefer functions over classes (classes only for errors/adapters)
8+
- Organize functions top-down: exports before helpers
9+
- Use JSDoc for complex functions; add tags only when justified beyond type signature
10+
- Use `import type` for types, regular `import` for values, separate statements even from same module
11+
- Prefix booleans with `is`/`has`/`can`/`should` (e.g., `isValid`, `hasData`) for clarity
12+
- Commenting Guidelines
13+
- Execution flow: Skip comments when code is self-documenting. Keep for complex logic, non-obvious "why", multi-line context, or if following a documented, multi-step flow.
14+
- Top of file/module: Use sparingly; only for non-obvious purpose/context or an overview of complex logic.
15+
- Type definitions: Property/interface documentation is always acceptable.

0 commit comments

Comments
 (0)