agentleFS
rafaelobrafaelob/pragmatic-agent-skills/skills/legacy-code-change/SKILL.md

legacy-code-change

Skill23 starsChanged 8 days agoApache-2.0View on GitHub

Use to change code that has no trusted tests, whether a fix, a feature or a refactor request: characterize, cut the smallest seam, red then green. Trusted tests, structure only -> refactoring-catalog. New code -> tdd.

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Sprout: Write the new behavior as a new function or class, fully tested on its own, and call it from one line in the old code.

    line 52
  2. Distinctive:

    Write and run the failing test at the real seam, implement only enough to make it green, then rerun the original characterization loop.

    line 67
  3. Distinctive:

    If a pinned behavior conflicts with the intended result, decide explicitly whether it is a bug or a contract.

    line 70
  4. Distinctive:

    Do not fix unrelated bugs while characterizing.

    line 88

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Legacy Code Change

Legacy code is code without tests you trust. Cleaning it up first would refactor without a net, judging correctness against what you think it does: pin the behavior first, then change it.

This skill starts from missing trust in the tests, whatever the change is: a fix, a feature or a restructuring request on untested code all begin here. Once the behavior is pinned, a structure-only change continues in refactoring-catalog. With trusted tests already in place, a structure-only request goes straight to refactoring-catalog and a behavior change to tdd. When the cause of a failure is unknown, use diagnosing-bugs first.

Workflow

1. Characterize the observed behavior — quirks included

At the real seam, pin only the behavior being changed and what it can reach. Start with one deliberately wrong assertion and run it to reveal the observed value; then cover reachable branches, boundaries and error paths. Mark deliberate quirks, such as test_..._quirk_preserves_trailing_space, instead of normalizing them.

For wide output, use one golden-master/approval snapshot. Stop when the net covers the change and blast radius; do not characterize an entire module for a small fix.

2. Cut the smallest seam that lets the test run

Often there is nowhere to observe from: the logic is buried in a 400-line method that hits the database, the clock, and the network. Take the smallest change that creates a testable boundary — and make it behavior-preserving.

  • Sprout. Write the new behavior as a new function or class, fully tested on its own, and call it from one line in the old code. The legacy mess stays untouched; the new logic is born under test. Default choice.
  • Wrap. Rename the old method, create a new one with the original name that calls the old one, and put the new behavior in the wrapper. Use when the new behavior must run before/after the existing one on every call.
  • Break a dependency, minimally: extract an interface, parameterize a constructor, extract-and-override in a test subclass, inject the clock. Only as much as the test needs.

Seam changes are structural, never semantic: same behavior, new boundary. Land them separately from the change you actually came to make.

3. Write the new behavior test before changing anything

Write and run the failing test at the real seam, implement only enough to make it green, then rerun the original characterization loop.

If a pinned behavior conflicts with the intended result, decide explicitly whether it is a bug or a contract; never rewrite the pin silently. If no correct seam exists, record that architectural finding instead of substituting a shallow test.

4. Exercise real collaborators; Remove the temporary harness

Exercise the changed path against real collaborators at least once; a test-double-only boundary is unproven. Remove temporary harnesses, debugging, dead toggles and redundant characterization tests; keep tests that pin undecided behavior.

Size the seam and the new-behavior test to the change, not to the whole legacy module.

5. Refactor green-to-green; keep the final diff clean

Refactor with refactoring-catalog for named moves, tests after each. Keep behavior-preserving structure changes separable from behavior changes; separate commits when they help a bisect or let a reviewer read the risky one alone.

Gotchas

  • Control nondeterminism (clock, randomness, ordering) before pinning behavior.
  • Do not fix unrelated bugs while characterizing.

Validation checklist

  • The changed behavior and reachable blast radius are characterized; quirks and nondeterminism are explicit.
  • The seam is structural and the new-behavior test was observed red before the fix.
  • Real collaborators were exercised, or the boundary is explicitly BLOCKED.
  • Temporary scaffolding is removed and intentional pins have reasons.

Cross-references

  • tdd: the red-green loop this borrows (there the behavior is new, here it exists). diagnosing-bugs: unknown cause, diagnose first. codebase-design: seam and module vocabulary. layered-testing-executor: which layers the change owes (decide from the project's own test layers, preferring the narrowest layer that proves the behavior).
  • Replacing the system instead of changing it is its own incremental migration (strangler-style cutover, parity checks), not a stretched version of this workflow.

Attribution

Practice vocabulary from Michael Feathers, Working Effectively with Legacy Code (2004) — characterization tests, seams, sprout and wrap. Approval/golden-master testing per Llewellyn Falco's approvals work.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.