Instruction file imported from simonwex/text-to-ux (.cursor/rules/implementation_tracking.mdc). Copyright stays with the author.

Implementation Tracking Rule

Purpose

To maintain accurate tracking of implementation progress against the IMPLEMENTATION_PLAN.md file.

Requirements

1. Task Completion Process:

   • After completing any task in the implementation plan:
     • Run all relevant tests to ensure functionality
     • Update the implementation plan by marking the task as complete with [x]
     • Commit changes with a descriptive message following the format below

2. Commit Message Format:

   feat: [IMPLEMENTATION] <Task Description>
   
   - Updates Phase <X> tasks in implementation plan
   - Marks <specific task> as complete
   - <Additional details about implementation>
   

3. Task Completion Criteria:

   • All associated tests must pass
   • Documentation must be updated if required
   • Code must follow project style guidelines
   • Any new dependencies must be added to requirements.txt
   • Changes must be committed with proper message format

4. Verification Steps: Before marking a task as complete:

   • Run pytest tests/ to verify all tests pass
   • Check that documentation is up to date
   • Verify code style compliance
   • Ensure all requirements are properly documented

Example

For completing the "Set up testing framework" task:

feat: [IMPLEMENTATION] Set up testing framework

- Updates Phase 1 tasks in implementation plan
- Marks "Set up testing framework" as complete
- Adds pytest configuration and initial test files
- Implements basic test cases for core functionality

Notes

• Tasks should only be marked as complete when all associated requirements are met
• If a task is partially complete, it should remain marked as [ ]
• Use the commit message to document any partial progress or blockers
• Reference specific requirements (e.g., REQ-1.1.2) in commit messages when applicable
• !NEVER commit unless the tests are passing