From d64939c3790fd98afcaf29bbd7e882bdf9cd7bb1 Mon Sep 17 00:00:00 2001 From: Alex Newman Date: Mon, 17 Nov 2025 15:45:33 -0500 Subject: [PATCH] docs: Add semantic naming principle and clean up migration docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- CLAUDE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 9f5d5c98..360edd6a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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 ## 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 4. **Simple First**: Write the obvious solution, optimize only if needed 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:** - 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 1. Update schema in `src/services/sqlite/schema.ts` 2. Update SessionStore/SessionSearch classes -3. Migration strategy: The plugin currently recreates on schema changes (acceptable for alpha) -4. TODO: Add proper migrations for production +3. Migration strategy: The plugin currently recreates on schema changes (alpha phase). Production deployments will require proper migration handling. ### Debugging Worker Issues ```bash