Skip to content

README.md

Latest commit

 

History

History
27 lines (19 loc) · 1.52 KB

README.md

File metadata and controls

27 lines (19 loc) · 1.52 KB
Raw

Agentic Coding Template

A language- and framework-agnostic template for projects that are driven by coding agents.

Any agent that opens this repository should start with AGENTS.md (or CLAUDE.md — they are the same file). It contains the ground rules, documentation map, and evolution policy.

Documentation map

  • docs/ — top-level documentation index.
  • docs/project/ — project overview, architecture, and boundaries.
  • docs/frontend/ — Feature-Sliced Design (FSD) conventions.
  • docs/backend/ — Domain-Driven Design (DDD) layered conventions.
  • docs/operations/ — development, CI/CD, and deployment guides.
  • docs/quality/ — testing, code-review expectations, and Agent Skills.
  • docs/decisions/ — architecture decision records (ADRs).
  • deploy/ — deployment assets (Docker, Kubernetes) to be adjusted per project.

For agents

  1. Read AGENTS.md first.
  2. Read the relevant section of docs/ before writing code.
  3. When a boundary is unclear, ask the user before making assumptions.
  4. After completing a task, update or add docs/ if the implementation changes behavior, architecture, or conventions.

Human quick start

Copy this repository, replace placeholders in docs/project/architecture.md, and start adding your own code under the FSD/DDD structure described in the docs.