2876cca8fe
Includes: CLAUDE.md, settings.json, agents, commands, rules, skills, hooks, contexts, evals, get-shit-done, plugin configs (installed list and marketplace sources). Excludes credentials, runtime caches, telemetry, session data, and plugin binary cache.
106 lines
2.7 KiB
Markdown
106 lines
2.7 KiB
Markdown
# CLAUDE.md Template
|
|
|
|
Template for project-root `CLAUDE.md` — auto-generated by `gsd-tools generate-claude-md`.
|
|
|
|
Contains 5 marker-bounded sections. Each section is independently updatable.
|
|
The `generate-claude-md` subcommand manages 4 sections (project, stack, conventions, architecture).
|
|
The profile section is managed exclusively by `generate-claude-profile`.
|
|
|
|
---
|
|
|
|
## Section Templates
|
|
|
|
### Project Section
|
|
```
|
|
<!-- GSD:project-start source:PROJECT.md -->
|
|
## Project
|
|
|
|
{{project_content}}
|
|
<!-- GSD:project-end -->
|
|
```
|
|
|
|
**Fallback text:**
|
|
```
|
|
Project not yet initialized. Run /gsd:new-project to set up.
|
|
```
|
|
|
|
### Stack Section
|
|
```
|
|
<!-- GSD:stack-start source:STACK.md -->
|
|
## Technology Stack
|
|
|
|
{{stack_content}}
|
|
<!-- GSD:stack-end -->
|
|
```
|
|
|
|
**Fallback text:**
|
|
```
|
|
Technology stack not yet documented. Will populate after codebase mapping or first phase.
|
|
```
|
|
|
|
### Conventions Section
|
|
```
|
|
<!-- GSD:conventions-start source:CONVENTIONS.md -->
|
|
## Conventions
|
|
|
|
{{conventions_content}}
|
|
<!-- GSD:conventions-end -->
|
|
```
|
|
|
|
**Fallback text:**
|
|
```
|
|
Conventions not yet established. Will populate as patterns emerge during development.
|
|
```
|
|
|
|
### Architecture Section
|
|
```
|
|
<!-- GSD:architecture-start source:ARCHITECTURE.md -->
|
|
## Architecture
|
|
|
|
{{architecture_content}}
|
|
<!-- GSD:architecture-end -->
|
|
```
|
|
|
|
**Fallback text:**
|
|
```
|
|
Architecture not yet mapped. Follow existing patterns found in the codebase.
|
|
```
|
|
|
|
### Profile Section (Placeholder Only)
|
|
```
|
|
<!-- GSD:profile-start -->
|
|
## Developer Profile
|
|
|
|
> Profile not yet configured. Run `/gsd:profile-user` to generate your developer profile.
|
|
> This section is managed by `generate-claude-profile` — do not edit manually.
|
|
<!-- GSD:profile-end -->
|
|
```
|
|
|
|
**Note:** This section is NOT managed by `generate-claude-md`. It is managed exclusively
|
|
by `generate-claude-profile`. The placeholder above is only used when creating a new
|
|
CLAUDE.md file and no profile section exists yet.
|
|
|
|
---
|
|
|
|
## Section Ordering
|
|
|
|
1. **Project** — Identity and purpose (what this project is)
|
|
2. **Stack** — Technology choices (what tools are used)
|
|
3. **Conventions** — Code patterns and rules (how code is written)
|
|
4. **Architecture** — System structure (how components fit together)
|
|
5. **Profile** — Developer behavioral preferences (how to interact)
|
|
|
|
## Marker Format
|
|
|
|
- Start: `<!-- GSD:{name}-start source:{file} -->`
|
|
- End: `<!-- GSD:{name}-end -->`
|
|
- Source attribute enables targeted updates when source files change
|
|
- Partial match on start marker (without closing `-->`) for detection
|
|
|
|
## Fallback Behavior
|
|
|
|
When a source file is missing, fallback text provides Claude-actionable guidance:
|
|
- Guides Claude's behavior in the absence of data
|
|
- Not placeholder ads or "missing" notices
|
|
- Each fallback tells Claude what to do, not just what's absent
|