Skip to content

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codebase Agentic Readiness Framework

"The more you sweat in peace, the less you bleed in war." In our context, sweating in peace is preparing the codebase for agentic participation. The war is when agents are implementing features from user prompts — and an unprepared codebase bleeds rework, hallucinations, and broken builds.


🎯 Choose Your Track

Whether you are starting a fresh project or modernizing an established monolith, this framework provides the blueprint to make your codebase safe, bounded, and deterministic for AI coding agents.

flowchart TD
    Start["What is your starting point?"] -->|Starting from scratch| TrackA["🚀 Greenfield Track\n(Day-0 Bootstrap)"]
    Start -->|Existing legacy codebase| TrackB["🏗️ Brownfield Track\n(Legacy Agentic Readiness)"]

    TrackA --> OutA["World-Class Harness\nfrom Commit #1"]
    TrackB --> OutB["Foundation\n(Phases 1–4)"]
    OutB --> OutC["Onwards to agentic-TDD/SDD \n(Phases 5–7)"]

    style TrackA fill:#2d6a4f,stroke:#1b4332,color:#fff
    style TrackB fill:#264653,stroke:#2a9d8f,color:#fff
    style OutA fill:#52b788,stroke:#40916c,color:#fff
    style OutB fill:#e9c46a,stroke:#f4a261,color:#000
    style OutC fill:#f4a261,stroke:#e76f51,color:#000
Loading

Track 1: Greenfield / Day-0 Project Setup 🚀

For new repositories and services.

Follow our step-by-step recipe to initialize a TypeScript / Node.js repository with world-class instrumentation before writing a single line of application logic. While our example is for TS/Node, the principles are the same for any tech/framework. You can point your coding agent to this structure and ask it to regenerate the same structure for your tech/framework. You should have something to review withing minutes.

  • 📖 Project Initialization Recipe — Step-by-step guide across 8 phases.
  • 📦 Reusable Scaffolding Templates — Copy-ready AGENTS.md, biome.json, GitHub Actions CI/CD workflows, vitest.config.ts, DI port interfaces, Diátaxis documentation templates (docs/STYLE_GUIDE.md, ADR templates), and the standardized six-verb command surface (format, lint, typecheck, test, check, security).

Track 2: Brownfield / Legacy Codebase Modernization 🏗️

For existing codebases, monoliths, and legacy services.

Follow our phased, incremental methodology to make any existing codebase agentic-ready without requiring a full rewrite.

  • 📖 Legacy Modernization Overview — The business case, defect reduction, and readiness roadmap.
  • 🗺️ 7-Phase Migration Guide:
    • Part I: Readiness Foundation (Phases 1–4) — Bootstrap, Source Docs, Agent Docs, and Behavioral Baselines. (Mandatory)
    • Part II: Post-Readiness Roadmap (Phases 5–7) — Agent-driven refactoring, human-facing docs, and Spec-Driven Development (SDD/BDD + TDD).

🏛️ Shared Framework Concepts

Both tracks share the same core intelligence layer and architectural invariants:

Document Description
Overview Core concepts, Constraint Engineering, assumptions, and applicability
Tool Ecosystem Accelerators (codebase-memory-mcp, agentic-tdd, etc.), maturity status, and conventions
Risks and Mitigations Risk matrix and safety principles when working with AI coding agents
Glossary Canonical definitions of domain terms
References External standards, frameworks, and related reading

🧠 Core Intelligence Layer

codebase-memory-mcp serves as the shared knowledge backbone across all workflows. Both human developers and AI agents query this graph to identify symbols, callers, callees, dependencies, contracts, and relevant documentation before making changes.


📄 License

This documentation is licensed under the GNU Free Documentation License, Version 1.3.

About

This is a recipe / guide to make your repo 'agentic-ready'

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages