Logical Refactor Workflow

Note: Commands below use npm as an example. Substitute with your project's package manager (yarn, pnpm, bun) or build tool when your project uses a different package manager.

Logical Refactor Workflow

Quick Start

Task Progress:
- [ ] Step 1: Read the issue, specs, and existing tests
- [ ] Step 2: Produce a change plan
- [ ] Step 3: Implement the behavior change
- [ ] Step 4: Update tests and verify invariants
- [ ] Step 5: Open PR

Step 1: Read Inputs

• Parse the issue body: motivation, before/after behavior, invariants preserved, invariants changed, acceptance criteria, affected files, risk analysis, testing plan.
• Read relevant project documentation: behavior engine, event model, data model, privacy, quality.
• Review existing tests to understand what behavior is currently asserted.
• For external library docs and current best practices, follow the project's tooling hierarchy.

Step 2: Change Plan

Before modifying code, output:

• Current behavior: how it works now
• New behavior: how it will work after
• Invariants preserved: list from issue + specs
• Invariants changed: list, with justification
• Cascading effects: which other flows/components are affected
• Files to modify: list with what changes
• Risks: what could go wrong

Step 3: Implement

• Implement behavior change as described in the before/after section.
• Verify every listed invariant is maintained (or explicitly updated with justification).
• Update any spec docs affected by the behavior change.

Step 4: Test

• Update existing tests that assert old behavior to assert new behavior.
• Add new tests for the new behavior, especially edge cases.
• Regression tests for preserved invariants.
• Integration tests if change affects cross-module interactions.

npm run lint && npm run typecheck && npm run test

Step 5: Open PR

Use the project's PR template. Include:

• Before/after behavior with concrete examples
• Invariants preserved and changed
• Test evidence for both new behavior and preserved behavior
• Spec docs updated (if any)

Error Handling

• Behavioral invariant violated during refactor: If a test that should pass now fails, check whether the invariant was incorrectly preserved or whether the refactor inadvertently changed behavior. Fix the refactor, not the test, unless the test was wrong.
• Refactor scope grows beyond the original task: If additional modules need changes to complete the refactor, stop, document the expanded scope, and get confirmation before continuing.
• Cannot verify behavioral equivalence due to missing tests: Write characterization tests for the current behavior before applying the refactor. This provides a safety net for the transformation.

Definition of Done

• New behavior matches the "after" description
• All preserved invariants verified with tests
• Changed invariants documented and justified
• Existing tests updated, new tests added
• Performance budgets maintained
• Privacy/security invariants respected
• Spec docs updated if behavior diverges from spec