44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# Task Completion Workflow
|
|
|
|
## Required Steps After Making Code Changes
|
|
|
|
1. **Build the Project**
|
|
```bash
|
|
pnpm build
|
|
```
|
|
Ensures TypeScript compiles without errors
|
|
|
|
2. **Run Tests**
|
|
```bash
|
|
pnpm test
|
|
```
|
|
Verifies functionality with test suite
|
|
|
|
3. **Type Check Test Files** (if tests were modified)
|
|
```bash
|
|
tsbuild check test/**/* --skiplibcheck
|
|
```
|
|
|
|
## Quality Checks
|
|
- Verify no TypeScript compilation errors
|
|
- Ensure all tests pass
|
|
- Check that new code follows existing patterns
|
|
- Verify imports use `.js` extensions for ES modules
|
|
- Confirm no hardcoded values that should be configurable
|
|
|
|
## Documentation Updates
|
|
- Update readme.md if API changes
|
|
- Add JSDoc comments for new public methods
|
|
- Update changelog.md for version changes
|
|
|
|
## Before Committing
|
|
- NEVER commit without explicit user approval
|
|
- Use `git status` to review changes
|
|
- Use `git diff` to verify modifications
|
|
- Create focused commits with clear messages
|
|
- Never commit secrets or API keys
|
|
|
|
## Important Notes
|
|
- The project uses pnpm exclusively (not npm or yarn)
|
|
- Always read documentation before using unfamiliar APIs
|
|
- Check existing code patterns before implementing new features |