mirror of
https://github.com/github/awesome-copilot.git
synced 2026-08-25 18:25:01 +00:00
Simplify AI Team Orchestration workflow 🤖 (#2439)
* Simplify AI Team Orchestration workflow Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify recovery context sources Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
denis-a-evdokimov
committed by
GitHub
GitHub
parent
0648d53070
commit
7968055c17
@@ -1,147 +1,70 @@
|
||||
# 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.
|
||||
|
||||
---
|
||||
Use this only when the project benefits from durable context across sessions. Keep it concise and omit irrelevant sections.
|
||||
|
||||
```markdown
|
||||
# PROJECT_BRIEF.md — [Project Name]
|
||||
# PROJECT_BRIEF.md - [Project Name]
|
||||
|
||||
> Last updated: [date] | Sprint [N] | Status: [In Progress / Complete]
|
||||
> Last updated: [date]
|
||||
|
||||
## 1. Project Overview
|
||||
## 1. Goal and Users
|
||||
|
||||
[3-4 sentences describing what the project is, who it's for, and the core goal.]
|
||||
[What the project is, who it serves, and the outcome it should create.]
|
||||
|
||||
## 2. Concept / Product Description
|
||||
## 2. Current Scope
|
||||
|
||||
[Detailed description of the product — user flows, key features, narrative if applicable.]
|
||||
**In scope**
|
||||
- [outcome]
|
||||
|
||||
## 3. Tech Stack
|
||||
**Out of scope**
|
||||
- [explicit exclusion]
|
||||
|
||||
- **Frontend:** [framework, language, key libraries]
|
||||
- **Backend:** [runtime, framework, database]
|
||||
- **Hosting:** [platform, CDN, storage]
|
||||
- **Testing:** [test framework, E2E tool]
|
||||
- **CI/CD:** [pipeline tool]
|
||||
## 3. Stack and Architecture
|
||||
|
||||
## 4. Architecture
|
||||
- Runtime/language: [value]
|
||||
- Frameworks/libraries: [value]
|
||||
- Data/services: [value]
|
||||
- Deployment: [value or not applicable]
|
||||
- Tests/checks: [verified commands]
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────┐
|
||||
│ 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).
|
||||
[Short architecture description or diagram when useful.]
|
||||
|
||||
## 4. Key Files
|
||||
|
||||
| Area | Path | Purpose |
|
||||
|---|---|---|
|
||||
| [area] | `[path]` | [purpose] |
|
||||
|
||||
## 5. How to Work
|
||||
|
||||
- Setup: [verified command or link]
|
||||
- Run: [verified command or link]
|
||||
- Test: [verified commands]
|
||||
- Deploy: [verified process or not applicable]
|
||||
- Repository rules: [links to contribution/security instructions]
|
||||
|
||||
## 6. Safety and Constraints
|
||||
|
||||
- [secrets/privacy/data rules]
|
||||
- [compatibility or reliability invariant]
|
||||
- [operational constraint]
|
||||
|
||||
## 7. Current State
|
||||
|
||||
**Working**
|
||||
- [item]
|
||||
|
||||
**Known issues**
|
||||
- [issue/link]
|
||||
|
||||
**Next**
|
||||
- [next outcome]
|
||||
|
||||
## 8. Team and Handoff
|
||||
|
||||
- Producer: scope, coordination, and merge
|
||||
- Dev: implementation and verification
|
||||
- QA: optional independent behavioral verification
|
||||
|
||||
Record material decisions, blockers, and the next action here or in the active plan. Use GitHub Issues or the repository's tracker for bugs and follow-up work.
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user