agentleFS
fortmortfortmort/jeltz/skills/project-bootstrap/SKILL.md

project-bootstrap

Skill4 starsChanged 9 months agoMITView on GitHub

Analyze an existing codebase, document its purpose, plan refactors to CLAUDE.md standards, and produce a TDD-ready TODO.

40 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use delivery-planning, diagnose and 4 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • lzx-BillSkill

    delivery-planning

    Use when breaking work into tasks, planning milestones, mapping dependencies, sequencing implementation, or maintaining backlog and in-progress views. Trigger when user says "task breakdown", "milestone", "dependencies", "backlog", "sprint", "implementation plan", "delivery plan", or asks to "break this down into tasks". Coordinate with prompt-authoring for task-to-prompt mapping and with acceptance-design for task-to-acceptance mapping.

    Also in 3 projects that use this

  • MicrosoftSkill

    diagnose

    Use to systematically diagnose why scenarios fail — identifies root causes by analyzing agent traces, codebase, and behavioral patterns

    Also in 3 projects that use this

  • MicrosoftSkill

    api-design

    Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API.

    Also in 3 projects that use this

  • GoogleSkill

    tdd

    Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

    Also in 3 projects that use this

  • GoogleSkill

    grill-me

    A relentless interview to sharpen a plan or design.

    Also in 3 projects that use this

  • +1 more from google

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 32 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write this as if you are explaining the system to a new senior engineer joining the team.

    line 65
  2. Very specific:

    All implementation work must follow TDD (red/green/refactor).

    line 148
  3. Very specific:

    Ensure tasks in docs/TODO.md are naturally compatible with:

    line 153
  4. Distinctive:

    Do not modify code in this skill.

    line 161
  5. Very specific:

    Do not weaken any requirement from CLAUDE.md or tdd-phase-loop.

    line 162
  6. Distinctive:

    Do not invent behavior not supported by the code or reference docs.

    line 163

“Common” is measured: kept by at least 6 in 10 of the 32 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

You are the project bootstrap auditor for an existing codebase.

Your job is to:

  1. Understand and document what the project does.
  2. Assess its quality against CLAUDE.md.
  3. Produce a concrete, TDD-ready implementation plan and TODO list.
  4. Reassert and align everything with the tdd-phase-loop TDD workflow.

You must work step by step, and you must write to three documents:

  • docs/PROJECT-SPECIFICATION.md
  • docs/IMPLEMENTATION-PLAN.md
  • docs/TODO.md

CLAUDE.md and tdd-phase-loop are authoritative and must be treated as hard constraints.


Inputs

You will be given:

  • The existing codebase (or relevant subset)
  • CLAUDE.md (engineering standards)
  • tdd-phase-loop skill (TDD workflow contract)
  • Any existing docs (if present)

You must not assume anything that is not supported by the code or docs.


Phase 1 -- Project Understanding & Specification

Goal: Understand and document what the project is and how it works.

  1. Read and infer purpose
    • Identify the primary purpose of the project.
    • Identify key entry points (CLIs, servers, tools, APIs).
    • Identify main domains (e.g., AWS, IAM, triage, etc.).
  2. Map logic flows
    • Identify major modules and their responsibilities.
    • Identify key data flows and control flows.
    • Identify important invariants and assumptions.
  3. Produce sequence diagrams
    • For each major workflow, produce a Mermaid sequence diagram.
    • Focus on:
      • inputs -> processing -> outputs
      • external calls (APIs, services)
      • error/exception paths where relevant
  4. Write docs/PROJECT-SPECIFICATION.md This file must include:
    • High-level project purpose
    • Key components and their responsibilities
    • Main workflows (with Mermaid sequence diagrams)
    • Key data models and their roles
    • Important invariants, constraints, and assumptions

Write this as if you are explaining the system to a new senior engineer joining the team.


Phase 2 -- Quality & Standards Assessment

Goal: Assess the current codebase against CLAUDE.md and best practices.

  1. Compare against CLAUDE.md
    • Coding style & naming
    • Logging & observability
    • Error handling
    • Testing (TDD, coverage, structure)
    • Security model (where applicable)
    • Dependency & licensing constraints
    • Tool design patterns (if relevant)
  2. Identify gaps
    • Where the code deviates from CLAUDE.md
    • Where logging is missing or insufficient
    • Where tests are missing, weak, or non-deterministic
    • Where structure or boundaries are unclear
    • Where security or isolation is at risk
  3. Write docs/IMPLEMENTATION-PLAN.md This file must include:
    • A concise summary of the current state
    • A high-level refactor plan to bring the codebase into alignment with CLAUDE.md
    • Grouped by themes, for example:
      • Logging & observability
      • Testing & TDD alignment
      • Structure & module boundaries
      • Security & isolation
      • Documentation & metadata
    • For each theme:
      • Goals
      • Constraints
      • Risks or tradeoffs

This is a high-level plan, not a task list. The task list comes next.


Phase 3 -- Task Decomposition to TODO

Goal: Decompose the implementation plan into discrete, achievable, testable tasks.

You must think explicitly about LLM context limits and conversation scope.

  1. Define task granularity Each task must:
    • Be completable in a single focused conversation (for one developer or one LLM session).
    • Have a clear, testable outcome.
    • Be small enough that the relevant code + tests + context fit comfortably in a single session.
  2. Decompose the plan
    • Break each theme from IMPLEMENTATION-PLAN.md into concrete tasks.
    • Each task should:
      • Reference the relevant modules/files
      • State the goal in one or two sentences
      • State the expected tests or verification criteria
      • Note any dependencies on other tasks
  3. Write docs/TODO.md This file must be a task list suitable for driving future TDD work.

    For each task, include:

    • A short, imperative title (e.g., “Add structured logging to session factory”)
    • A brief description of what must change
    • Expected tests or verification steps (e.g., “update/extend tests in tests/unit/...”, “ensure logs at INFO/DEBUG as per CLAUDE.md”)
    • Any ordering/dependency notes (e.g., “after X”, “before Y”)

This TODO will be used to restart conversations with generative AI assistants and human developers, so it must be self-contained and unambiguous.


Phase 4 -- TDD & tdd-phase-loop Reassertion

Goal: Reassert that all future work follows TDD and the tdd-phase-loop skill.

At the end of your analysis, you must:

  1. Explicitly state in docs/IMPLEMENTATION-PLAN.md and/or docs/TODO.md that:
    • All implementation work must follow TDD (red/green/refactor).
    • The tdd-phase-loop skill is the required workflow for all future changes.
    • Tests must be written first, then minimal implementation, then refactor.
    • Logging, security, and other CLAUDE.md requirements are non-negotiable.
  2. Ensure tasks in docs/TODO.md are naturally compatible with:
    • TDD (each task should be testable)
    • tdd-phase-loop (each task can be executed as a RED -> GREEN -> REFACTOR cycle)

Hard Constraints

  • Do not modify code in this skill; you are only analyzing and writing docs.
  • Do not weaken any requirement from CLAUDE.md or tdd-phase-loop.
  • Do not invent behavior not supported by the code or reference docs.
  • Be explicit, concise, and structured in all three output files.
  • Assume future work will be done strictly via TDD and tdd-phase-loop.

Begin by reading the existing codebase and CLAUDE.md, then proceed with Phase 1.

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.