agentleFS
arumaekawaarumaekawa/codex-skills/skills/design-first/SKILL.md

design-first

Skill4 starsChanged 4 months agoMITView on GitHub

Produce a concrete implementation design from repository evidence before changing code. Use before making any code change unless a concrete and unambiguous implementation design is provided.

5 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 5

    Distinctive

    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:

    Do not implement the change while using this skill.

    line 9
  2. Distinctive:

    Read the code and other repository evidence relevant to the requested change.

    line 13
  3. Distinctive:

    Start with cohesive implementation units.

    line 25
  4. Distinctive:

    Do not add fallback behavior, broad input handling, or unused flexibility that the request does not require.

    line 26
  5. Distinctive:

    Use clear errors for unsupported or unexpected states instead of guessing or silently continuing.

    line 27

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “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

Design First

Inspect the existing implementation and produce a concrete design before changing the code. Do not implement the change while using this skill.

Workflow

  1. Read the code and other repository evidence relevant to the requested change.
  2. Identify the behavior to change and the behavior to preserve.
  3. Define the concrete code scope and implementation design.
  4. Review the design against the requested behavior, existing contracts, and design principles. Simplify or revise it before finalizing.
  5. Define how the changed and preserved behavior will be verified.
  6. Record or return the design as directed by the caller.

Design Principles

  • Design the change to fit the existing implementation. Prefer direct local structural improvement over side paths, adapters, or compatibility layers.
  • Identify any small behavior-preserving tidy that should precede implementation, and keep it distinct from the behavior change.
  • Start with cohesive implementation units; extract functions or classes only when the responsibility is worth naming.
  • Do not add fallback behavior, broad input handling, or unused flexibility that the request does not require.
  • Use clear errors for unsupported or unexpected states instead of guessing or silently continuing.

Design Information

The design should include:

  1. Behavior
    • What should change.
    • What should be preserved.
  2. Code Scope
    • The file paths, classes, functions, and modules to change or add.
    • Material interfaces and dependencies.
    • High-level pseudocode only when it helps clarify a non-obvious design.
  3. Flow
    • Include a short flow only when branching or data movement would otherwise be unclear.
  4. Verification
    • Define verification that demonstrates both changed and preserved behavior.
  5. Assumptions and Open Questions
    • Include only unresolved items that materially affect implementation.

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.