Documentation
README
Commit
Create clean, well-structured git commits that tell a coherent story.
Process
1. Assess the Working Tree
Run git status (never -uall) and git diff to understand what changed. Also run git log --oneline -5 to match the repo's existing commit message style.
If there are no changes, say so and stop.
2. Group Changes by Intent
Look at the changed files and mentally group them:
- Feature: new functionality (client + server + tests for the same feature = one commit)
- Fix: bug fixes
- Refactor: structural changes that don't change behavior
- Docs: documentation-only changes (CLAUDE.md, README, comments)
- Test: test-only additions or changes
- Chore: config, dependencies, tooling
This is the opening of the README. Read the full README on GitHub.