mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-30 20:25:55 +00:00
8cb29415be
* Add ai-team-orchestration plugin: multi-agent dev team with Producer, Dev Team, QA agents * fix: use kebab-case agent names to match filenames * fix: regenerate README after agent name change * fix: address Copilot review — add edit tools to Producer/QA, use GitHub closing keywords * fix: update agent tools to official VS Code tool set names Replace outdated/nonexistent tool names with current official tool sets: - Producer: search, read, edit, web (removed nonexistent githubRepo) - Dev Team: search, read, edit, execute, web (replaced runCommands, problems, usages, etc.) - QA: search, read, edit, execute, web (removed nonexistent findTestFiles, runTests) Ref: https://code.visualstudio.com/docs/copilot/reference/copilot-vscode-features#_chat-tools * fix: remove frontmatter from plugin README per reviewer feedback --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
148 lines
5.2 KiB
Markdown
148 lines
5.2 KiB
Markdown
# PROJECT_BRIEF.md Template
|
|
|
|
Copy this template to your project root and fill in every section. **Do not abbreviate sections 12-14** — they are critical for cross-chat context survival.
|
|
|
|
---
|
|
|
|
```markdown
|
|
# PROJECT_BRIEF.md — [Project Name]
|
|
|
|
> Last updated: [date] | Sprint [N] | Status: [In Progress / Complete]
|
|
|
|
## 1. Project Overview
|
|
|
|
[3-4 sentences describing what the project is, who it's for, and the core goal.]
|
|
|
|
## 2. Concept / Product Description
|
|
|
|
[Detailed description of the product — user flows, key features, narrative if applicable.]
|
|
|
|
## 3. Tech Stack
|
|
|
|
- **Frontend:** [framework, language, key libraries]
|
|
- **Backend:** [runtime, framework, database]
|
|
- **Hosting:** [platform, CDN, storage]
|
|
- **Testing:** [test framework, E2E tool]
|
|
- **CI/CD:** [pipeline tool]
|
|
|
|
## 4. Architecture
|
|
|
|
```
|
|
┌─────────────────────────────────────────┐
|
|
│ Frontend │
|
|
│ [Main Component] → [Sub Components] │
|
|
└──────────────┬──────────────────────────┘
|
|
│ HTTPS
|
|
┌──────────────▼──────────────────────────┐
|
|
│ Backend API │
|
|
│ [Endpoints and their purpose] │
|
|
└──────────────┬──────────────────────────┘
|
|
│
|
|
┌──────────────▼──────────────────────────┐
|
|
│ Storage / Database │
|
|
│ [Tables, collections, env vars] │
|
|
└─────────────────────────────────────────┘
|
|
```
|
|
|
|
## 5. Key Files Map
|
|
|
|
| Area | Path | Contents |
|
|
|------|------|----------|
|
|
| Entry point | `src/main.tsx` | App bootstrap |
|
|
| API | `api/src/` | Server-side logic |
|
|
| Config | `api/src/config/` | Server-only configuration |
|
|
| Tests | `tests/` | E2E and API tests |
|
|
| Sprint docs | `docs/sprint-N/` | Plans, progress, done |
|
|
|
|
## 6. Team Roles
|
|
|
|
| Agent | Name | Role |
|
|
|-------|------|------|
|
|
| Producer | Remy | Sprint plans, coordination, merging |
|
|
| Frontend | Nova | UI components, state, client logic |
|
|
| Backend | Sage | API, auth, database, security |
|
|
| Art/CSS | Milo | Visual design, animations, polish |
|
|
| QA | Ivy | Testing, bug filing, sign-off |
|
|
| Product | Kira | UX design, mechanics, feature specs |
|
|
| DevOps | Dash | CI/CD, deployment, infrastructure |
|
|
|
|
## 7. Sprint Status
|
|
|
|
| Sprint | Name | Status | Scope |
|
|
|--------|------|--------|-------|
|
|
| 0 | Architecture | ✅ Done | Tech stack, project structure, design guide |
|
|
| 1 | Core Features | 🔨 In Progress | [scope description] |
|
|
|
|
## 8. Current State (rewrite every sprint)
|
|
|
|
**What works:**
|
|
- [List of working features]
|
|
|
|
**What doesn't work yet:**
|
|
- [Known issues]
|
|
|
|
**What's next:**
|
|
- [Next sprint goals]
|
|
|
|
## 9. Security Rules
|
|
|
|
1. Secrets live in environment variables only — never in code or git.
|
|
2. [Auth approach]
|
|
3. [Additional security rules]
|
|
|
|
## 10. How to Run Locally
|
|
|
|
```bash
|
|
npm install
|
|
cd api && npm install
|
|
cp api/local.settings.json.example api/local.settings.json
|
|
npm run dev:all
|
|
```
|
|
|
|
## 11. How to Deploy
|
|
|
|
[Pipeline description, env var locations, deployment steps]
|
|
|
|
## 12. Cross-Chat Handoff Protocol
|
|
|
|
Every sprint chat must do these before finishing:
|
|
|
|
1. Write `docs/sprint-N/done.md` — what was built, what's not done, what needs manual setup, files changed/created
|
|
2. Update PROJECT_BRIEF.md: Section 7 (mark sprint done) + Section 8 (rewrite current state)
|
|
3. Commit all changes with descriptive message: `sprint-N: <summary>`
|
|
|
|
This is how context survives across chats. If skipped, the next chat starts blind and may overwrite or duplicate work. The repo is the shared memory — keep it accurate.
|
|
|
|
## 13. Bug & Fix Tracking
|
|
|
|
Bugs are tracked as GitHub Issues on the repo. Single source of truth for all teams.
|
|
|
|
**For QA:** File bugs as GitHub Issues with labels (`bug`, `severity:blocker/major/minor`). Include: component, steps to reproduce, expected vs actual. When no blockers found: write `docs/qa/sprint-N-signoff.md` with test count, pass rate, explicit "no blockers" statement.
|
|
|
|
**For Dev Team:** Check GitHub Issues before starting work. Fix blockers and majors before polish. Use GitHub closing keywords in commits: `fix: description (Fixes #42)`. For reference-only, use `Refs #42`.
|
|
|
|
**For DevOps:** File infrastructure issues with label `infra`.
|
|
|
|
**For feature ideas:** add to `docs/ideas-backlog.md`.
|
|
|
|
## 14. Multi-Repo Setup
|
|
|
|
Each team works in their own separate clone of the repo. No worktrees. Everyone works on their own branch, pushes to origin, creates PRs.
|
|
|
|
**Teams:**
|
|
- Producer on `main` (coordination hub)
|
|
- Dev Team on `feature/sprint-N`
|
|
- QA on `feature/qa-N`
|
|
- DevOps on `feature/devops-N` (only when needed)
|
|
|
|
**Setup:**
|
|
```bash
|
|
git clone <repo> <folder-name>
|
|
cd <folder-name>
|
|
git checkout -b <branch-name>
|
|
npm install
|
|
```
|
|
|
|
**Branch strategy:** Feature branches → PR → regular merge to main. Never push directly to main. Never squash. Never rebase feature branches (causes commit loss).
|
|
```
|