airkjw/claude-mem
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add semantic naming principle and clean up migration docs

Browse Source 
Added semantic naming to coding standards emphasizing verbose,
self-documenting names for comprehension. Cleaned up database
migration section removing TODO in favor of clear evergreen statement.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Alex Newman
2025-11-17 15:45:33 -05:00
parent 97d8bd3e62
commit d64939c379
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+4 -2
View File
@@ -1,3 +1,5 @@
/* To @claude: be vigilant about only leaving evergreen context in this file, claude-mem handles working context separately. */
# Claude-Mem: AI Development Instructions # Claude-Mem: AI Development Instructions
## What This Project Is ## What This Project Is
@@ -122,6 +124,7 @@ Changes to React components, styles, or viewer logic require rebuilding and rest
3. **Fail Fast**: Explicit errors beat silent failures 3. **Fail Fast**: Explicit errors beat silent failures
4. **Simple First**: Write the obvious solution, optimize only if needed 4. **Simple First**: Write the obvious solution, optimize only if needed
5. **Delete Aggressively**: Less code = fewer bugs 5. **Delete Aggressively**: Less code = fewer bugs
6. **Semantic Naming**: Always name variables, parameters, and API endpoints with verbose, self-documenting names that optimize for comprehension by both humans and LLMs, not brevity (e.g., `wait_until_obs_is_saved=true` vs `wait=true`)
**Common anti-patterns to avoid:** **Common anti-patterns to avoid:**
- Ceremonial wrapper functions for constants (just export the constant) - Ceremonial wrapper functions for constants (just export the constant)
@@ -145,8 +148,7 @@ Changes to React components, styles, or viewer logic require rebuilding and rest
### Modifying Database Schema ### Modifying Database Schema
1. Update schema in `src/services/sqlite/schema.ts` 1. Update schema in `src/services/sqlite/schema.ts`
2. Update SessionStore/SessionSearch classes 2. Update SessionStore/SessionSearch classes
3. Migration strategy: The plugin currently recreates on schema changes (acceptable for alpha) 3. Migration strategy: The plugin currently recreates on schema changes (alpha phase). Production deployments will require proper migration handling.
4. TODO: Add proper migrations for production
### Debugging Worker Issues ### Debugging Worker Issues
```bash ```bash