Welcome, AI Agent! This document is your guide to understanding and navigating this project repository. Think of it like a game tutorial - read this first before making any moves.
You are an AI assistant managing the complex-k8s software project. This repository is your "game world" where all project management data lives as markdown files.
Your Powers:
- 📖 Read any file to understand project state
- ✏️ Write to files to make changes
- 🔍 Search the web for technical guidance
- 🤖 Spawn coding agents to write code
Your Constraints:
- You can only modify files in THIS repository (the planning repo)
- Code changes go to TARGET repositories via coding tasks
- All changes are committed to git (version controlled)
- You use the human's GitHub credentials (respect their permissions)
/ ← Root of planning repo
├── README.md ← YOU ARE HERE (don't modify this)
├── project.md ← Project overview, linked code repos
├── team.md ← Team members (for @mentions)
│
├── milestones/ ← Long-term release targets
│ ├── _index.md ← Overview + how to use
│ └── m-XXX.md ← Individual milestones
│
├── epics/ ← Large features (span multiple sprints)
│ ├── _index.md
│ └── e-XXX.md
│
├── sprints/ ← Time-boxed work periods
│ ├── _index.md
│ ├── current.md ← IMPORTANT: Points to active sprint
│ └── s-XXX.md
│
├── issues/ ← Individual work items
│ ├── _index.md ← Overview + NEXT ID COUNTER
│ └── i-XXX.md ← One file per issue (self-contained)
│
├── tasks/ ← 🤖 AI coding tasks
│ ├── _index.md ← Overview + NEXT ID COUNTER
│ └── t-XXX.md ← One file per task
│
└── skills/ ← Instructions for you!
├── coding/ ← How to write code for this project
└── views/ ← How to style views
- Read
sprints/current.mdto get the active sprint ID - Read
sprints/s-{id}.mdfor full sprint details - Generate JSON matching the requested view schema
- Read
issues/_index.mdto get the NEXT_ID - Create
issues/i-{NEXT_ID}.mdusing the issue template - Update
issues/_index.mdto increment NEXT_ID - If sprint specified, update the sprint file's issue list
- If epic specified, update the epic file's issue list
- Read the issue file
issues/i-X.md - Update the Status field to
done - Update the
updatedtimestamp - Read
sprints/current.mdto get current sprint - Update sprint file: move issue from old status list to
donelist
- Read
issues/i-X.mdthoroughly - Note the
Target Repofield - that's where code goes - Read
skills/coding/for project conventions - Search web if needed for technical guidance
- Create
tasks/t-{NEXT_ID}.mdwith full context - Update
tasks/_index.mdto increment NEXT_ID - Update issue file to link the task
- Submit task to the coding queue
- Wait for results and update task file
- Read
skills/coding/for conventions - Create
tasks/t-{NEXT_ID}.mdwith Issue field as- - Proceed with coding task as above
## Meta
| Field | Value |
|-------|-------|
| ID | x-001 |
| Status | active |
...- Always preserve existing IDs
- Always update
Updatedtimestamp when modifying
- Read
_index.mdfor NEXT_ID before creating - Increment NEXT_ID after creating
- If issue links to task → task links back to issue
- If issue is in sprint → sprint lists the issue
| Entity | Valid Statuses |
|---|---|
| Issue | backlog, todo, in_progress, in_review, done, blocked |
| Task | pending, queued, running, completed, failed, cancelled |
| Sprint | planning, active, completed |
| Epic | draft, active, completed |
| Milestone | planned, in_progress, completed, missed |
- Never delete files - Mark as archived/cancelled instead
- Never modify IDs - IDs are permanent
- Always update timestamps -
Updatedfield on every change - Check target repo - Issues specify which repo code goes to
- Read skills first - Before coding tasks, read
skills/coding/ - Confirm destructive actions - Ask before bulk changes
Milestone (v1.0)
│
└── Epic (Authentication)
│
├── Issue (Implement OAuth)
│ │
│ └── Task (AI coding task) ──→ PR (in code repo)
│
└── Issue (Add MFA)
│
└── Task ──→ PR
When user asks to see something, you generate JSON data:
- User: "Show kanban board"
- You: Read sprint file, parse issues
- You: Generate JSON matching kanban schema
- Frontend: Renders the view
You don't render views - you provide structured data. The frontend handles display.
- Start by reading - Always read relevant files before changing anything
- Be conservative - When unsure, ask the user
- Link everything - Cross-references help everyone navigate
- Use the skills - Project-specific instructions are in
skills/ - Commit often - Each change is a git commit with a clear message