agent-md-template

A collection of project-specific markdown templates for AI coding agents (Claude, Gemini, etc.). Provides AGENTS.md, CLAUDE.md, GEMINI.md, and detailed guide documents tailored to each project type.

한국어 README

---

How to Use

1. Choose the language folder (en/ or ko/), then select the folder matching your project type.
2. Copy the files from that folder into your project root.
3. Replace placeholders ({name}, {Name}, {package}, etc.) to match your project.
4. For feature documents, copy docs/architecture/feature/_template.md and create one per feature.

---

Template List

Folder	Project Type	Description
kmp/	Kotlin Multiplatform (App)	Clean Architecture, Compose Multiplatform, Koin DI, Offline-First
kmp-library/	Kotlin Multiplatform (Library)	Open-source library, API design, expect/actual, Maven Central publishing
kotlin-webflux/	Kotlin WebFlux (Backend)	Hexagonal + Clean Architecture, DDD, TDD, Coroutine-First
react/	React (Admin)	Vite, TypeScript, TanStack Query, page-based domain module structure
rust-axum/	Rust / Axum (Backend)	Hexagonal + Clean Architecture, DDD, TDD, Async-First
terraform/	Terraform (IaC)	Environment isolation, shared modules, remote state, security

---

Folder Structure

.
├── en/                     # English templates
│   ├── kmp/
│   ├── kmp-library/
│   ├── kotlin-webflux/
│   ├── react/
│   ├── rust-axum/
│   └── terraform/
├── ko/                     # Korean templates
│   ├── kmp/
│   ├── kmp-library/
│   ├── kotlin-webflux/
│   ├── react/
│   ├── rust-axum/
│   └── terraform/
├── README.md               # This file (English)
└── README.ko.md            # Korean README

Each template folder contains:

File	Role
AGENTS.md	Single Source of Truth for project-wide guidelines. Contains agent document routing, architecture principles, and decision rules
CLAUDE.md	Entry point for Claude Code. References AGENTS.md
GEMINI.md	Entry point for Gemini. References AGENTS.md
docs/	Detailed guide documents. Referenced from AGENTS.md routing table

---

Adding a New Project Type

1. Create a new folder under both en/ and ko/ (e.g., en/flutter/, ko/flutter/).
2. Write AGENTS.md, CLAUDE.md, GEMINI.md.
3. Add architecture, convention, and technology-specific guides under docs/.
4. Register in this README's template list.

---

Contributing

• When modifying existing templates, maintain generality. Do not include content specific to a particular project.
• When adding new guide documents, register them in the AGENTS.md routing table and docs/architecture/README.md index.
• Keep both en/ and ko/ versions in sync.