33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
|
# Task Completion Checklist
|
||
|
|
|
||
|
|
When completing any coding task in this project, always:
|
||
|
|
|
||
|
|
## Before Committing
|
||
|
|
1. **Build the project**: Run `pnpm build` to ensure TypeScript compiles
|
||
|
|
2. **Run tests**: Execute `pnpm test` to verify nothing is broken
|
||
|
|
3. **Type check**: Verify types compile correctly
|
||
|
|
4. **Check for lint issues**: Look for any code style violations
|
||
|
|
|
||
|
|
## Code Quality Checks
|
||
|
|
- Verify all imports are in `ts/plugins.ts` for external dependencies
|
||
|
|
- Check that interfaces are prefixed with `I`
|
||
|
|
- Check that types are prefixed with `T`
|
||
|
|
- Ensure filenames are lowercase
|
||
|
|
- Verify async patterns are preserved where needed
|
||
|
|
- Check that decorators are properly used for MongoDB documents
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
- Update relevant comments if functionality changed
|
||
|
|
- Ensure new exports are properly documented
|
||
|
|
- Update readme.md if new features added (only if explicitly requested)
|
||
|
|
|
||
|
|
## Git Hygiene
|
||
|
|
- Make small, focused commits
|
||
|
|
- Write clear commit messages
|
||
|
|
- Use `git mv` for file operations
|
||
|
|
- Never commit sensitive data or keys
|
||
|
|
|
||
|
|
## Final Verification
|
||
|
|
- Test the specific functionality that was changed
|
||
|
|
- Ensure no unintended side effects
|
||
|
|
- Verify the change solves the original problem completely
|