From e2e8cc15d6a7a62b003d042547ec3ce39301c6d5 Mon Sep 17 00:00:00 2001
From: Jiayuan <forrestchang7@gmail.com>
Date: Fri, 30 Jan 2026 04:05:05 +0800
Subject: [PATCH] docs: add CLAUDE.md with atomic commits instructions (#16)

---
 CLAUDE.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 CLAUDE.md

diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 00000000..1bdd00ae
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,62 @@
+# Project Instructions for AI Agents
+
+## Atomic Commits
+
+After completing any task that modifies code, you MUST create atomic commits before ending the conversation. Do not ask for permission - just do it.
+
+### Workflow
+
+1. **Check for changes**: Run `git status` and `git diff` to see all modifications
+2. **Skip if clean**: If there are no changes, skip the commit process
+3. **Analyze changes**: Group changes by their logical purpose:
+   - Feature additions
+   - Bug fixes
+   - Refactoring
+   - Documentation
+   - Tests
+   - Configuration/dependencies
+4. **Create atomic commits**: For each logical group, stage only the relevant files and create a separate commit
+
+### Commit Process
+
+For each logical group of changes:
+
+```bash
+# Stage specific files for this logical change
+git add <file1> <file2>
+
+# Commit with conventional commit message
+git commit -m "<type>(<scope>): <description>"
+```
+
+### Commit Message Format
+
+Use conventional commits:
+- `feat`: New feature
+- `fix`: Bug fix
+- `refactor`: Code refactoring (no functional change)
+- `docs`: Documentation changes
+- `test`: Adding or updating tests
+- `chore`: Build, config, dependencies
+
+### Examples
+
+If you modified:
+- `src/api/user.ts` (added new endpoint)
+- `src/api/user.test.ts` (tests for new endpoint)
+- `src/utils/format.ts` (refactored helper)
+- `README.md` (updated docs)
+
+Create three commits:
+1. `git add src/api/user.ts src/api/user.test.ts && git commit -m "feat(api): add user profile endpoint"`
+2. `git add src/utils/format.ts && git commit -m "refactor(utils): simplify date formatting logic"`
+3. `git add README.md && git commit -m "docs: update API documentation"`
+
+### Rules
+
+- Each commit should be independently meaningful and buildable
+- Related test files should be committed with their implementation
+- Never create empty commits
+- Never combine unrelated changes in one commit
+- Keep commit messages concise but descriptive
+- If all changes are related to one logical unit, a single commit is fine