antialias/soroban-abacus-flashcards
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: expand quality regime to define "done" for all work

Browse Source 
Update regime documentation to clarify that quality checks must pass
not just before commits, but before declaring ANY work complete.

**"Done" means:**
- npm run pre-commit passes (0 errors, 0 warnings)
- All TypeScript errors fixed
- All code formatted
- All linting passed

**Quality checks required before:**
- Committing code
- Saying work is "done" or "complete"
- Marking tasks as finished
- Telling the user something is "working" or "fixed"

This ensures quality standards are maintained throughout development,
not just at commit time.

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Thomas Hallock
2025-10-07 12:53:31 -05:00
parent dd1104310f
commit f92f7b592a
2 changed files with 35 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
apps/web/.claude/CLAUDE.md
View File

@@ -1,8 +1,15 @@
# Claude Code Instructions for apps/web
## MANDATORY: Pre-Commit Quality Checks
## MANDATORY: Quality Checks for ALL Work
**BEFORE EVERY COMMIT**, you MUST run and pass these checks:
**BEFORE declaring ANY work complete, fixed, or working**, you MUST run and pass these checks:
### When This Applies
- Before every commit
- Before saying "it's done" or "it's fixed"
- Before marking a task as complete
- Before telling the user something is working
- After any code changes, no matter how small
```bash
npm run pre-commit
@@ -18,14 +25,20 @@ This command runs:
## Workflow
When asked to make changes and commit:
When asked to make ANY changes:
1. Make your code changes
2. Run `npm run pre-commit`
3. If it fails, fix the issues and run again
4. Only create commits after all checks pass
4. Only after all checks pass can you:
- Say the work is "done" or "complete"
- Mark tasks as finished
- Create commits
- Tell the user it's working
5. Push immediately after committing
**Nothing is complete until `npm run pre-commit` passes.**
## Details
See `.claude/CODE_QUALITY_REGIME.md` for complete documentation.

20
apps/web/.claude/CODE_QUALITY_REGIME.md
View File

@@ -1,8 +1,24 @@
# Code Quality Regime
**MANDATORY**: Before ANY commit, Claude MUST run these checks and fix all issues.
**MANDATORY**: Before declaring ANY work complete, fixed, or working, Claude MUST run these checks and fix all issues.
## Pre-Commit Checklist (Always Required)
## Definition of "Done"
Work is NOT complete until:
- ✅ All TypeScript errors are fixed (0 errors)
- ✅ All code is formatted with Biome
- ✅ All linting passes (0 errors, 0 warnings)
- ✅ `npm run pre-commit` exits successfully
**Until these checks pass, the work is considered incomplete.**
## Quality Check Checklist (Always Required)
Run these before:
- Committing code
- Saying work is "done" or "complete"
- Marking tasks as finished
- Telling the user something is "working" or "fixed"
Run these commands in order. All must pass with 0 errors and 0 warnings: