37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
|
# Task Completion Checklist for TaskBuffer
|
||
|
|
|
||
|
|
## Before Marking Any Task Complete
|
||
|
|
|
||
|
|
### 1. Code Quality Checks
|
||
|
|
- [ ] Run build to ensure TypeScript compiles: `pnpm run build`
|
||
|
|
- [ ] Run tests to ensure nothing breaks: `pnpm test`
|
||
|
|
- [ ] Type check test files: `tsbuild check test/**/* --skiplibcheck`
|
||
|
|
|
||
|
|
### 2. Code Review
|
||
|
|
- [ ] All changes are focused and purposeful
|
||
|
|
- [ ] No unnecessary modifications made
|
||
|
|
- [ ] Code follows project naming conventions
|
||
|
|
- [ ] Imports use the plugins.ts pattern where applicable
|
||
|
|
- [ ] All async operations use proper async/await
|
||
|
|
|
||
|
|
### 3. Testing
|
||
|
|
- [ ] New features have corresponding tests
|
||
|
|
- [ ] Existing tests still pass
|
||
|
|
- [ ] Test files end with `export default tap.start()`
|
||
|
|
- [ ] Tests use proper expect from tapbundle
|
||
|
|
|
||
|
|
### 4. Documentation
|
||
|
|
- [ ] readme.md updated if new features added
|
||
|
|
- [ ] Code is self-explanatory (no comments unless requested)
|
||
|
|
- [ ] API changes documented
|
||
|
|
|
||
|
|
### 5. Git Hygiene
|
||
|
|
- [ ] Changes are staged appropriately
|
||
|
|
- [ ] Commit message is clear and focused
|
||
|
|
- [ ] NO commits made without explicit user approval
|
||
|
|
|
||
|
|
## Common Issues to Check
|
||
|
|
- No uppercase filenames
|
||
|
|
- No direct npm usage (use pnpm)
|
||
|
|
- No guessing APIs (always check documentation)
|
||
|
|
- No partial implementations
|