vibesuite 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agent/skills/agent-recovery/SKILL.md +147 -0
- package/.agent/skills/code-review/SKILL.md +81 -0
- package/.agent/skills/component-analysis/SKILL.md +103 -0
- package/.agent/skills/git-worktree/SKILL.md +78 -0
- package/.agent/skills/github-ops/SKILL.md +220 -0
- package/.agent/skills/github-ops/scripts/publish_issues.ps1 +443 -0
- package/.agent/skills/github-ops/scripts/smart-ops.ps1 +128 -0
- package/.agent/skills/github-ops/scripts/smart-ops.sh +130 -0
- package/.agent/skills/google-trends/SKILL.md +157 -0
- package/.agent/skills/google-trends/scripts/node_modules/.modules.yaml +21 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/LICENSE +22 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/Readme.md +1157 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/esm.mjs +16 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/index.js +24 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/lib/argument.js +149 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/lib/command.js +2509 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/lib/error.js +39 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/lib/help.js +520 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/lib/option.js +330 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/lib/suggestSimilar.js +101 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/package-support.json +16 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/package.json +84 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/typings/esm.d.mts +3 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/commander@12.1.0/node_modules/commander/typings/index.d.ts +969 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/CHANGES.md +132 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/LICENSE +21 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/README.md +561 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/lib/google-trends-api.min.js +2 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/package.json +68 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/src/api.js +18 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/src/index.js +27 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/src/request.js +69 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/google-trends-api@4.9.2/node_modules/google-trends-api/src/utilities.js +395 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm/lock.yaml +31 -0
- package/.agent/skills/google-trends/scripts/node_modules/.pnpm-workspace-state-v1.json +25 -0
- package/.agent/skills/google-trends/scripts/package.json +17 -0
- package/.agent/skills/google-trends/scripts/pnpm-lock.yaml +31 -0
- package/.agent/skills/google-trends/scripts/search.js +168 -0
- package/.agent/skills/high-fidelity-extraction/SKILL.md +59 -0
- package/.agent/skills/prime-agent/SKILL.md +97 -0
- package/.agent/skills/security-audit/SKILL.md +81 -0
- package/.agent/skills/seo-ready/SKILL.md +133 -0
- package/.agent/skills/spawn-task/SKILL.md +130 -0
- package/.agent/skills/sync-docs/SKILL.md +88 -0
- package/.agent/skills/vercel-ai-sdk/SKILL.md +34083 -0
- package/.agent/skills/youtube-pipeline/SKILL.md +194 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-phase1-strategy.md +224 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-phase2-packaging.md +148 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-phase3-scripting.md +197 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-phase3.5-shorts.md +271 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-phase4-production.md +193 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-phase5-repurposing.md +159 -0
- package/.agent/skills/youtube-pipeline/resources/youtube-pipeline.md +161 -0
- package/.agent/skills/youtube-pipeline/scripts/parse_yt_studio.ps1 +150 -0
- package/.agent/workflows/LEGACY/ANTIGRAVITY_TOOLBOX.md +200 -0
- package/.agent/workflows/LEGACY/analyze_component.md +141 -0
- package/.agent/workflows/LEGACY/build_vibecode_project.md +154 -0
- package/.agent/workflows/LEGACY/deep_code_audit.md +79 -0
- package/.agent/workflows/LEGACY/gemini-orchestrate.md +63 -0
- package/.agent/workflows/LEGACY/git_worktree.md +71 -0
- package/.agent/workflows/LEGACY/init_smart_ops.md +101 -0
- package/.agent/workflows/LEGACY/multi_agent_strategy.md +62 -0
- package/.agent/workflows/LEGACY/orchestrate.md +321 -0
- package/.agent/workflows/LEGACY/seo_ready.md +249 -0
- package/.agent/workflows/LEGACY/vibe-orchestrator.md +305 -0
- package/.agent/workflows/LEGACY/youtube-phase1-strategy.md +224 -0
- package/.agent/workflows/LEGACY/youtube-phase2-packaging.md +148 -0
- package/.agent/workflows/LEGACY/youtube-phase3-scripting.md +197 -0
- package/.agent/workflows/LEGACY/youtube-phase3.5-shorts.md +271 -0
- package/.agent/workflows/LEGACY/youtube-phase4-production.md +193 -0
- package/.agent/workflows/LEGACY/youtube-phase5-repurposing.md +159 -0
- package/.agent/workflows/LEGACY/youtube-pipeline.md +161 -0
- package/.agent/workflows/README.md +349 -0
- package/.agent/workflows/Vercel Ai SDK.md +34083 -0
- package/.agent/workflows/agent_reset.md +138 -0
- package/.agent/workflows/build_vibecode_project_v2.md +158 -0
- package/.agent/workflows/escalate.md +112 -0
- package/.agent/workflows/init_vibecode_design.md +98 -0
- package/.agent/workflows/init_vibecode_genesis.md +137 -0
- package/.agent/workflows/migrate.md +135 -0
- package/.agent/workflows/prime_agent.md +211 -0
- package/.agent/workflows/reverse_genesis.md +132 -0
- package/.agent/workflows/review_code.md +133 -0
- package/.agent/workflows/spawn-jstar-code-review.md +121 -0
- package/.agent/workflows/spawn_task.md +187 -0
- package/.agent/workflows/sync_docs.md +90 -0
- package/Legacy (Manual Method)/0 VibeCode User Manual.md +173 -0
- package/Legacy (Manual Method)/1 Project Genesis Protocol The VibeCode Workflow.md +89 -0
- package/Legacy (Manual Method)/2/342/234/250 ULTIMATE ORCHESTRATION PROMPT/342/234/250.md" +114 -0
- package/Legacy (Manual Method)/3 Design System Genesis Protocol.md +75 -0
- package/Legacy (Manual Method)/3.1.1 my_design_system_rules.md +177 -0
- package/Legacy (Manual Method)/3.1.2 Material You M3 Genesis Protocol.md +73 -0
- package/Legacy (Manual Method)/4 The Ultimate GitHub Issue Meta-Prompt Template.md +54 -0
- package/Legacy (Manual Method)/5 The Escalation & Handoff Protocol.md +97 -0
- package/Legacy (Manual Method)/8 The Seamless Migration Meta-Prompt (Your Reusable Tool).md +38 -0
- package/Legacy (Manual Method)/9 The Reverse Genesis Protocol.md +75 -0
- package/README.md +209 -0
- package/VibeCode-Agents (e.g Kilo-code)/README.md +142 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-analyzer.yaml +254 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-architect.yaml +397 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-auditor.yaml +325 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-builder.yaml +472 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-designer.yaml +305 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-documentor.yaml +222 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-escalator.yaml +255 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-isolator.yaml +332 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-onboarder.yaml +335 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-orchestrator.yaml +365 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-orchestrator_legacy.yaml +284 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-orchestrator_v1.yaml +336 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-primer.yaml +213 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-reviewer.yaml +233 -0
- package/VibeCode-Agents (e.g Kilo-code)/vibe-spawner.yaml +259 -0
- package/bin/vibesuite.js +2 -0
- package/package.json +43 -0
- package/src/cli.js +159 -0
- package/src/utils.js +76 -0
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Spawn J Star Code Review bot into the current repository
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /spawn-jstar - Add J Star Reviewer v2 to Any Project
|
|
6
|
+
|
|
7
|
+
Works with **any programming language** — TypeScript, Python, Rust, Go, etc.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
- Node.js 18+ installed on your machine
|
|
11
|
+
|
|
12
|
+
## Steps
|
|
13
|
+
|
|
14
|
+
### 1. Install the CLI Globally (One Time) use pnpm by default else revert to npm
|
|
15
|
+
// turbo
|
|
16
|
+
```bash
|
|
17
|
+
pnpm install -g jstar-reviewer
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### 2. Run your First Command
|
|
21
|
+
// turbo
|
|
22
|
+
```bash
|
|
23
|
+
jstar setup
|
|
24
|
+
```
|
|
25
|
+
*(Or simply run `jstar review` if you already have your keys ready)*
|
|
26
|
+
|
|
27
|
+
This **auto-creates** (or updates):
|
|
28
|
+
- `.jstar/` directory
|
|
29
|
+
- `.env.example` with required variables
|
|
30
|
+
- `.gitignore` (appends `.jstar/` and `.env.local`)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### 3. Configure Environment Variables
|
|
34
|
+
```bash
|
|
35
|
+
cp .env.example .env.local
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Edit `.env.local` and add your API keys:
|
|
39
|
+
```env
|
|
40
|
+
GEMINI_API_KEY=your_gemini_api_key_here
|
|
41
|
+
GROQ_API_KEY=your_groq_api_key_here
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
**Where to get keys:**
|
|
45
|
+
- Google API Key: [Google AI Studio](https://aistudio.google.com/apikey)
|
|
46
|
+
- Groq API Key: [console.groq.com](https://console.groq.com)
|
|
47
|
+
|
|
48
|
+
### 4. Index Your Codebase (Build the Brain)
|
|
49
|
+
```bash
|
|
50
|
+
jstar init
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
This scans your codebase and creates embeddings for context-aware reviews.
|
|
54
|
+
|
|
55
|
+
### 5. (Optional) Create Rules File
|
|
56
|
+
Create `.jstar/rules.md` with your project-specific coding guidelines:
|
|
57
|
+
|
|
58
|
+
```markdown
|
|
59
|
+
# Project Coding Rules
|
|
60
|
+
|
|
61
|
+
## General
|
|
62
|
+
- Follow PEP 8 (Python) / Google Style Guide
|
|
63
|
+
- Add docstrings to all public functions
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## Security
|
|
68
|
+
- Never log sensitive data
|
|
69
|
+
- Validate all user inputs
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### 6. Understanding Review Modes
|
|
73
|
+
Before running a review, understand the available modes:
|
|
74
|
+
|
|
75
|
+
| Mode | Command | Best For |
|
|
76
|
+
| :--- | :--- | :--- |
|
|
77
|
+
| **Standard** | `jstar review` | checking staged changes *before* committing. |
|
|
78
|
+
| **Retroactive** | `jstar review --last` | checking the *last commit* (if you forgot to review). |
|
|
79
|
+
| **Pull Request** | `jstar review --pr` | checking an entire feature branch against `main`. |
|
|
80
|
+
|
|
81
|
+
### 7. Run Your First Review
|
|
82
|
+
|
|
83
|
+
**Agent Instruction:** Ask the user: *"Would you like to run the review yourself, or should I run a headless check for you?"*
|
|
84
|
+
|
|
85
|
+
#### Option A: User Runs It (Recommended)
|
|
86
|
+
The user runs the interactive TUI command in their terminal:
|
|
87
|
+
```bash
|
|
88
|
+
jstar review
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
#### Option B: Agent Runs It (Headless)
|
|
92
|
+
If the user asks YOU to do it, use the headless flag to avoid hanging:
|
|
93
|
+
// turbo
|
|
94
|
+
```bash
|
|
95
|
+
jstar review --headless
|
|
96
|
+
```
|
|
97
|
+
*(This outputs JSON-formatted results that you can parse)*
|
|
98
|
+
|
|
99
|
+
The dashboard will be saved to `.jstar/last-review.md`.
|
|
100
|
+
|
|
101
|
+
## Done! 🎉
|
|
102
|
+
|
|
103
|
+
**CLI Commands:**
|
|
104
|
+
| Command | Description |
|
|
105
|
+
|---------|-------------|
|
|
106
|
+
| `jstar setup` | Create config files in current project |
|
|
107
|
+
| `jstar init` | Index codebase (after major changes) |
|
|
108
|
+
| `jstar review` | Review staged changes (Default) |
|
|
109
|
+
| `jstar review --last` | Review last commit (Retroactive) |
|
|
110
|
+
| `jstar review --pr` | Review branch against main (PR Mode) |
|
|
111
|
+
|
|
112
|
+
**Output:**
|
|
113
|
+
- Console: Quick summary with severity counts
|
|
114
|
+
- `.jstar/last-review.md`: Full dashboard with fix prompts
|
|
115
|
+
|
|
116
|
+
## Alternative: Without Global Install
|
|
117
|
+
|
|
118
|
+
If you don't want to install globally:
|
|
119
|
+
```bash
|
|
120
|
+
npx jstar-reviewer review
|
|
121
|
+
```
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Spawn a detailed task prompt for implementing a feature or fixing a bug.
|
|
3
|
+
---
|
|
4
|
+
# Workflow: Spawn Task
|
|
5
|
+
|
|
6
|
+
**System Instruction:**
|
|
7
|
+
You are a **Task Architect** who creates comprehensive, self-contained task prompts.
|
|
8
|
+
These prompts should be detailed enough that another agent (or your future self) can pick them up and execute without additional context.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
User: "Use /spawn_task for implementing user profile avatars"
|
|
16
|
+
User: "Spawn a task for fixing the login redirect bug"
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Steps
|
|
20
|
+
|
|
21
|
+
### 1. Task Discovery
|
|
22
|
+
Gather information from the user:
|
|
23
|
+
- **Task Description:** What needs to be done?
|
|
24
|
+
- **Priority:** High / Medium / Low
|
|
25
|
+
- **Scope:** What's included/excluded?
|
|
26
|
+
- **Timeline:** Expected completion time (optional)
|
|
27
|
+
|
|
28
|
+
### 2. Current State Analysis
|
|
29
|
+
|
|
30
|
+
Analyze the project context:
|
|
31
|
+
```bash
|
|
32
|
+
# Check for related files
|
|
33
|
+
find src -name "*relevant*" -type f
|
|
34
|
+
|
|
35
|
+
# Check for related documentation
|
|
36
|
+
ls docs/features/
|
|
37
|
+
|
|
38
|
+
# Check for related issues
|
|
39
|
+
gh issue list --search "[related term]"
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Document:
|
|
43
|
+
- **Completed:** What's already done
|
|
44
|
+
- **In Progress:** Current work
|
|
45
|
+
- **Pending:** What needs to be done
|
|
46
|
+
- **Blockers:** Any obstacles
|
|
47
|
+
|
|
48
|
+
### 3. Generate Task Prompt
|
|
49
|
+
|
|
50
|
+
Create a comprehensive task prompt in `docs/tasks/[TaskName].md`:
|
|
51
|
+
|
|
52
|
+
```markdown
|
|
53
|
+
# 🎯 Task: [Task Name]
|
|
54
|
+
|
|
55
|
+
**Objective:** [Clear, measurable goal]
|
|
56
|
+
**Priority:** [High/Medium/Low]
|
|
57
|
+
**Scope:** [What's included/excluded]
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 📋 Requirements
|
|
62
|
+
|
|
63
|
+
### Functional Requirements
|
|
64
|
+
- **[REQ-001]** [Requirement with acceptance criteria]
|
|
65
|
+
- **[REQ-002]** [Requirement with acceptance criteria]
|
|
66
|
+
|
|
67
|
+
### Technical Requirements
|
|
68
|
+
- **[TECH-001]** [Technical specification]
|
|
69
|
+
- **[TECH-002]** [Performance/security requirements]
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 🏗️ Implementation Plan
|
|
74
|
+
|
|
75
|
+
### Phase 1: Setup
|
|
76
|
+
- [ ] [Setup task 1]
|
|
77
|
+
- [ ] [Setup task 2]
|
|
78
|
+
|
|
79
|
+
### Phase 2: Core Implementation
|
|
80
|
+
- [ ] [Core task 1]
|
|
81
|
+
- [ ] [Core task 2]
|
|
82
|
+
|
|
83
|
+
### Phase 3: Enhancement
|
|
84
|
+
- [ ] [Enhancement task 1]
|
|
85
|
+
- [ ] [Enhancement task 2]
|
|
86
|
+
|
|
87
|
+
### Phase 4: Testing & Documentation
|
|
88
|
+
- [ ] [Testing task]
|
|
89
|
+
- [ ] [Documentation task]
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## 📁 Files to Create/Modify
|
|
94
|
+
|
|
95
|
+
| File | Action | Purpose |
|
|
96
|
+
|------|--------|---------|
|
|
97
|
+
| `src/features/[Feature]/...` | Create | [Purpose] |
|
|
98
|
+
| `src/lib/...` | Modify | [Purpose] |
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## ✅ Success Criteria
|
|
103
|
+
|
|
104
|
+
### Code Quality
|
|
105
|
+
- [ ] TypeScript compliant (no `any`)
|
|
106
|
+
- [ ] Passes ESLint
|
|
107
|
+
- [ ] Unit tests with >80% coverage
|
|
108
|
+
|
|
109
|
+
### Performance
|
|
110
|
+
- [ ] Bundle size increase < 5KB
|
|
111
|
+
- [ ] No memory leaks
|
|
112
|
+
- [ ] Load time < 1.5s
|
|
113
|
+
|
|
114
|
+
### Functionality
|
|
115
|
+
- [ ] All requirements implemented
|
|
116
|
+
- [ ] Error handling for all scenarios
|
|
117
|
+
- [ ] Mobile responsive
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 🔗 Dependencies
|
|
122
|
+
|
|
123
|
+
**Depends on:**
|
|
124
|
+
- [Other components/features this needs]
|
|
125
|
+
|
|
126
|
+
**Used by:**
|
|
127
|
+
- [Components that will use this]
|
|
128
|
+
|
|
129
|
+
**Related files:**
|
|
130
|
+
- `[path/to/related/file.ts]`
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## 🚀 Getting Started
|
|
135
|
+
|
|
136
|
+
1. Read this task prompt completely
|
|
137
|
+
2. Review the related files listed above
|
|
138
|
+
3. Begin with Phase 1: Setup
|
|
139
|
+
4. Provide progress updates after each phase
|
|
140
|
+
5. Deliver final results with documentation
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
*Generated by /spawn_task workflow*
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### 4. Related Issue (Optional)
|
|
148
|
+
|
|
149
|
+
If this task should be tracked in GitHub:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
gh issue create \
|
|
153
|
+
--title "[Feature] [Task Name]" \
|
|
154
|
+
--body "See docs/tasks/[TaskName].md for full task specification" \
|
|
155
|
+
--label "enhancement"
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### 5. Confirmation
|
|
159
|
+
|
|
160
|
+
**Final Message:**
|
|
161
|
+
"📋 **Task Spawned.**
|
|
162
|
+
|
|
163
|
+
Created: `docs/tasks/[TaskName].md`
|
|
164
|
+
|
|
165
|
+
This task prompt is self-contained and ready for execution.
|
|
166
|
+
|
|
167
|
+
**Options:**
|
|
168
|
+
- **A)** Start implementing now (I'll follow the phases)
|
|
169
|
+
- **B)** Create a GitHub Issue to track this
|
|
170
|
+
- **C)** Just save the task for later
|
|
171
|
+
|
|
172
|
+
What would you like to do?"
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## Quick Reference
|
|
177
|
+
|
|
178
|
+
### Task Categories
|
|
179
|
+
- 🆕 **Feature** - New functionality
|
|
180
|
+
- 🐛 **Bug Fix** - Fixing broken behavior
|
|
181
|
+
- ♻️ **Refactor** - Improving existing code
|
|
182
|
+
- 📚 **Documentation** - Writing docs
|
|
183
|
+
|
|
184
|
+
### Priority Guidelines
|
|
185
|
+
- **High:** Blocking other work, user-facing bugs
|
|
186
|
+
- **Medium:** Important features, non-blocking issues
|
|
187
|
+
- **Low:** Nice-to-haves, minor improvements
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Document recent code changes by reviewing and updating feature docs
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Documentation Sync Workflow
|
|
6
|
+
|
|
7
|
+
This workflow updates `docs/features/` after major code changes.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
- You have just completed a code change (feature, fix, refactor)
|
|
11
|
+
- You know which files were modified
|
|
12
|
+
|
|
13
|
+
## Steps
|
|
14
|
+
|
|
15
|
+
### 1. Identify Changed Components
|
|
16
|
+
List the main files that were modified in the recent change. Focus on:
|
|
17
|
+
- `src/main/` (backend logic)
|
|
18
|
+
- `src/renderer/` (UI components)
|
|
19
|
+
- `src/shared/` (types, constants)
|
|
20
|
+
|
|
21
|
+
### 2. List Existing Feature Docs
|
|
22
|
+
// turbo
|
|
23
|
+
```bash
|
|
24
|
+
ls docs/features/
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 3. Read Doc Names and Summaries
|
|
28
|
+
For each doc, read the first 20 lines to understand its scope:
|
|
29
|
+
// turbo
|
|
30
|
+
```bash
|
|
31
|
+
head -20 docs/features/*.md
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### 4. Determine Action
|
|
35
|
+
For each changed component, decide:
|
|
36
|
+
- **UPDATE** an existing doc if the feature already has documentation
|
|
37
|
+
- **CREATE** a new doc if this is a new feature or subsystem
|
|
38
|
+
- **SKIP** if the change is minor and already covered
|
|
39
|
+
|
|
40
|
+
### 5. Documentation Standards
|
|
41
|
+
Each feature doc should follow this template:
|
|
42
|
+
|
|
43
|
+
```markdown
|
|
44
|
+
# Feature Name
|
|
45
|
+
|
|
46
|
+
## Overview
|
|
47
|
+
One paragraph explaining what this feature does.
|
|
48
|
+
|
|
49
|
+
## Architecture
|
|
50
|
+
- **Service/File:** `src/main/path/to/file.ts`
|
|
51
|
+
- **Dependencies:** List key dependencies
|
|
52
|
+
|
|
53
|
+
## Key Components
|
|
54
|
+
|
|
55
|
+
### Component 1
|
|
56
|
+
Explanation...
|
|
57
|
+
|
|
58
|
+
### Component 2
|
|
59
|
+
Explanation...
|
|
60
|
+
|
|
61
|
+
## Data Flow (optional)
|
|
62
|
+
Use mermaid diagrams for complex flows:
|
|
63
|
+
```mermaid
|
|
64
|
+
flowchart LR
|
|
65
|
+
A --> B --> C
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Configuration (if applicable)
|
|
69
|
+
| Setting | Type | Default | Description |
|
|
70
|
+
|---------|------|---------|-------------|
|
|
71
|
+
| ... | ... | ... | ... |
|
|
72
|
+
|
|
73
|
+
## Hotfixes / Changelog (optional)
|
|
74
|
+
Document significant bug fixes with dates:
|
|
75
|
+
### Hotfix YYYY-MM-DD: Brief Title
|
|
76
|
+
- **Problem:** What was broken
|
|
77
|
+
- **Solution:** How it was fixed
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 6. Write Updates
|
|
81
|
+
- If **UPDATE**: Use `view_file` to read the existing doc, then `replace_file_content` to add/modify sections.
|
|
82
|
+
- If **CREATE**: Use `write_to_file` to create a new doc following the template above.
|
|
83
|
+
|
|
84
|
+
### 7. Verify Links
|
|
85
|
+
Ensure any file paths mentioned in docs are correct (use backticks for paths).
|
|
86
|
+
|
|
87
|
+
### 8. Summary
|
|
88
|
+
After completion, list what was updated/created:
|
|
89
|
+
- Updated: `docs/features/foo.md` (added XYZ section)
|
|
90
|
+
- Created: `docs/features/bar.md` (new feature doc)
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
### **The VibeCode Protocol Suite: A User Manual v2.0**
|
|
2
|
+
|
|
3
|
+
Welcome to VibeCode. This isn't just a collection of prompts; it's a complete system for collaborating with AI to build software. Think of yourself as the Visionary or the CEO, and your AI assistants as a specialized, high-performance team. This guide explains who's on your team and which playbook (protocol) to use for any situation you'll encounter.
|
|
4
|
+
|
|
5
|
+
## Your AI Team: The Cast of Characters
|
|
6
|
+
|
|
7
|
+
You'll work with a few different types of AI agents. Knowing who does what is the first step.
|
|
8
|
+
|
|
9
|
+
* **The AI Orchestrator (Your "Senior Architect"):** This is your main strategic partner (e.g., GPT-4o, Claude 3 Opus). It doesn't write the first line of code. Its job is to think, plan, architect, and create documentation. It understands the "vibe" and the big picture.
|
|
10
|
+
* **The Builder/Executor (Your "Workhorse Coder"):** This AI takes a single, massive, detailed prompt from the Orchestrator and builds the entire initial project foundation in one go. It's great at execution, not strategy.
|
|
11
|
+
* **The In-IDE Assistant (Your "Pair Programmer"):** This AI lives in your code editor (e.g., GitHub Copilot, Cursor). It's a tactical expert, helping you write or fix individual functions, generate tests, and refactor small pieces of code. It works best when given very specific, in-the-moment tasks.
|
|
12
|
+
* **The Design Agent (Your "UI/UX Specialist"):** A specialized AI (like Midjourney for concepts or a GPT-4V model for code) that focuses purely on visual design, creating style guides and HTML/CSS mockups based on a strict set of rules.
|
|
13
|
+
|
|
14
|
+
## The VibeCode Playbook: A Protocol for Every Situation
|
|
15
|
+
|
|
16
|
+
Here’s your library of protocols. Use this guide to know which one to grab and when.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
### **1. Starting a Brand New Project**
|
|
21
|
+
|
|
22
|
+
When you have a new idea, this is your starting line. We have two protocols for this, but one is the standard for any real project.
|
|
23
|
+
|
|
24
|
+
#### **Your Go-To Choice (99% of the time): `Project Genesis Protocol The VibeCode Workflow.md`**
|
|
25
|
+
|
|
26
|
+
**➡️ When to use it:** Always. Use this for any new project, from a simple utility to a full-blown web application.
|
|
27
|
+
|
|
28
|
+
**➡️ What it does:** This is more than just a prompt; it's a **workflow installer**. It doesn't just ask the AI for code; it establishes the "vibe," sets up your collaborative dynamic, and defines the project's entire personality. It turns your AI from a simple code generator into a genuine project partner. It handles planning, documentation (ingesting any coding guidelines you provide), initial code, and the future roadmap, all in one go.
|
|
29
|
+
|
|
30
|
+
**➡️ How to use it:**
|
|
31
|
+
|
|
32
|
+
1. Open `Project Genesis Protocol The VibeCode Workflow.md`.
|
|
33
|
+
2. Follow the instructions inside. It will guide you through a conversation with your **AI Orchestrator**.
|
|
34
|
+
3. The process will feel like a project kickoff meeting. At the end, you'll have all the foundational documents, the first batch of code, and a clear path forward.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
#### **The Alternative (For Quick Scripts & Boilerplate): `✨ ULTIMATE ORCHESTRATION PROMPT✨.md`**
|
|
39
|
+
|
|
40
|
+
**➡️ When to use it:** On the rare occasion you are **not** starting a full project. Use this when you need a single, self-contained piece of code and don't need the surrounding project structure, documentation, or long-term "vibe" setup.
|
|
41
|
+
|
|
42
|
+
* **Good for:** A standalone Python script for data processing, a complex SQL query, a single HTML/CSS component for a landing page.
|
|
43
|
+
* **Bad for:** Anything with multiple files, a potential for future features, or that requires a consistent architectural vision.
|
|
44
|
+
|
|
45
|
+
**➡️ What it does:** This is a direct, powerful, "one-shot" prompt. You give it a detailed spec, and it gives you a block of code. It's less of a collaborator and more of a highly-skilled contractor hired for a single task.
|
|
46
|
+
|
|
47
|
+
**➡️ How to use it:**
|
|
48
|
+
|
|
49
|
+
1. Open `✨ ULTIMATE ORCHESTRATION PROMPT✨.md`.
|
|
50
|
+
2. Fill out the sections with your technical requirements.
|
|
51
|
+
3. Give the completed prompt to your **AI Orchestrator** or even a powerful **Builder Agent**.
|
|
52
|
+
4. You will get code back, but not the deep project context or workflow you get from the Genesis Protocol.
|
|
53
|
+
|
|
54
|
+
| Feature | Project Genesis Protocol | Ultimate Orchestration Prompt |
|
|
55
|
+
| :-------------- | :----------------------------------------------- | :------------------------------------------ |
|
|
56
|
+
| **Best For** | **Full Projects (Web apps, desktop apps, etc.)** | **Single Scripts, Boilerplate, Components** |
|
|
57
|
+
| **Output** | Code + Docs + GitHub Issues + Project Vibe | Just Code |
|
|
58
|
+
| **Interaction** | Conversational, like a project kickoff | One-shot, transactional |
|
|
59
|
+
| **When to Use** | **Your default, 99% of the time** | The 1% where you just need a file |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
### **2. Defining the Visual 'Vibe' (The Design System)**
|
|
63
|
+
|
|
64
|
+
After project genesis, it's time to define the look and feel. This is a crucial step, and we have two distinct approaches: a flexible, discovery-based method and a rigorous, system-based method.
|
|
65
|
+
|
|
66
|
+
#### **Understanding the Tools**
|
|
67
|
+
|
|
68
|
+
First, let's clarify what the different "Design" files are for:
|
|
69
|
+
|
|
70
|
+
* `3.1.1 my_design_system_rules.md` - **This is The Rulebook.** It is not a prompt you run. It is the constitution, the single source of truth that defines the entire visual language of your project in a token-based system (colors, fonts, shapes, etc.). It's the "law" that the best protocols follow.
|
|
71
|
+
* `3.1.2 Material You M3 Genesis Protocol.md` - **This is The Architect's Protocol.** This is the prompt you run to *apply* the rules from the rulebook. It's a highly advanced protocol that builds a complete, professional design system from a single "seed" color, ensuring perfect consistency and adherence to the rules.
|
|
72
|
+
* `3 Design System Genesis Protocol.md` - **This is The Artist's Protocol.** This is the original, more flexible protocol. It's less about enforcing a strict system and more about discovering a "vibe" with the AI.
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
#### **Your Go-To Choice (Modern, "Google-Feel" Apps): The Architect's Approach (Using 3.1.1 + 3.1.2)**
|
|
77
|
+
|
|
78
|
+
**➡️ When to use it:** For any serious application where you need a professional, consistent, and modern UI. This is the recommended approach for achieving that polished "Google feel." It eliminates guesswork and ensures every design decision is systematic.
|
|
79
|
+
|
|
80
|
+
**➡️ How it works:** It's a two-part process where the protocol enforces the rulebook.
|
|
81
|
+
|
|
82
|
+
1. **Internalize the Law:** The system starts with the `3.1.1 my_design_system_rules.md` as its unbreakable foundation.
|
|
83
|
+
2. **Execute the Protocol:** You give `3.1.2 Material You M3 Genesis Protocol.md` to your **AI Orchestrator**. It will act as a "Material Design System Architect," using the rulebook as its guide.
|
|
84
|
+
3. **Provide the Seed:** You give the Architect a single hex code that represents your brand (e.g., `#005BFF`). The protocol then algorithmically generates the *entire* accessible color palette for light and dark themes, perfectly mapped to the tokens in the rulebook.
|
|
85
|
+
4. **Receive the Blueprints:** The Orchestrator gives you final, high-fidelity prompts for a **Design Agent** to create flawless, token-driven mockups. Every instruction will be prescriptive, like "The button background MUST use `color-primary`."
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
#### **The Alternative (Flexible & Bespoke): The Artist's Approach (Using 3)**
|
|
90
|
+
|
|
91
|
+
**➡️ When to use it:** When you *don't* want to be constrained by a strict system like Material Design. Use this for more experimental projects, landing pages, or when you are in the early stages of brand discovery and need to explore different aesthetics.
|
|
92
|
+
|
|
93
|
+
**➡️ How it works:**
|
|
94
|
+
|
|
95
|
+
1. Give `3 Design System Genesis Protocol.md` to your **AI Orchestrator**.
|
|
96
|
+
2. The Orchestrator will ask you for more subjective inputs: a "design vibe," specific brand colors you've already picked, and font preferences.
|
|
97
|
+
3. It will then generate a custom design system and mockups based on your creative direction. This process is more of a collaboration to find a style rather than the execution of a pre-defined one.
|
|
98
|
+
|
|
99
|
+
| Feature | The Architect's Approach (3.1.2 + 3.1.1) | The Artist's Approach (3) |
|
|
100
|
+
| :-------------- | :--------------------------------------------------- | :--------------------------------------------------- |
|
|
101
|
+
| **Best For** | **Systematic, professional web/mobile apps** | **Creative exploration, landing pages, branding** |
|
|
102
|
+
| **Input** | A single **seed color** & project mission | A "vibe," a full color palette, font choices |
|
|
103
|
+
| **Process** | **Prescriptive.** Applies a strict set of rules. | **Descriptive.** Discovers a style with you. |
|
|
104
|
+
| **Output** | A token-based, M3-compliant design system. | A custom, bespoke design system. |
|
|
105
|
+
| **When to Use** | **Your default for building robust applications.** | When you need creative freedom over system rigidity. |
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
### **3. Joining an Existing Project**
|
|
110
|
+
|
|
111
|
+
**➡️ When to use it:** You're starting work on a codebase you didn't create. You need to get your AI Orchestrator up to speed so it can help you effectively.
|
|
112
|
+
|
|
113
|
+
**➡️ What it does:** Uses a two-phase process to "scan" an existing project and brief your Orchestrator, making it an instant expert on the codebase.
|
|
114
|
+
|
|
115
|
+
**➡️ How to use it:**
|
|
116
|
+
|
|
117
|
+
1. **Phase 1 (Reconnaissance):** Open `The Reverse Genesis Protocol.md`. Copy the "Recon Prompt" and give it to your **In-IDE Assistant** (since it can read your local files). It will generate a detailed "Project Autopsy Report."
|
|
118
|
+
2. **Phase 2 (Briefing):** Copy the "Mission Briefing" prompt from the same file. Paste the "Autopsy Report" into it, add your new goals, and give this final, combined prompt to your **AI Orchestrator**. It will now understand the project and be ready to help you plan new features.
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
### **4. When Your AI Coder Gets Stuck**
|
|
123
|
+
|
|
124
|
+
**➡️ When to use it:** Your **In-IDE Assistant** is trying to implement a feature but is failing. It's stuck in a loop, giving you errors, or just not understanding the task.
|
|
125
|
+
|
|
126
|
+
**➡️ What it does:** Provides a formal "escalation" path. It forces the failing local AI to document its own failure, and then uses that report to brief the high-level **AI Orchestrator** so it can devise a better strategy.
|
|
127
|
+
|
|
128
|
+
**➡️ How to use it:**
|
|
129
|
+
|
|
130
|
+
1. **Part 1 (Damage Report):** Open `The Escalation & Handoff Protocol.md`. Copy the "Damage Report" prompt and give it to the failing **In-IDE Assistant**. It will give you back a summary of the goal, the error, and the files it was working on.
|
|
131
|
+
2. **Part 2 (SOS Call):** Copy the "SOS" prompt from the same file. Paste the "Damage Report" and the full code from the relevant files into it. Give this to your **AI Orchestrator**. It will analyze the situation and give you a new, corrected plan.
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
### **5. When Your AI Chat Is Getting Old**
|
|
136
|
+
|
|
137
|
+
**➡️ When to use it:** You've been in a single chat session with your Orchestrator for a long time. It's starting to lose context, forget details, or the window is getting laggy.
|
|
138
|
+
|
|
139
|
+
**➡️ What it does:** Generates a "state snapshot" prompt that perfectly captures the entire project history, your dynamic, and the current goals. You use this to start a fresh, new chat session without losing any momentum.
|
|
140
|
+
|
|
141
|
+
**➡️ How to use it:**
|
|
142
|
+
|
|
143
|
+
1. Open `The Seamless Migration Meta-Prompt (Your Reusable Tool).md`.
|
|
144
|
+
2. Give this prompt to your current **AI Orchestrator** and fill in the details it asks for (personas, project details, key milestones, next steps).
|
|
145
|
+
3. The Orchestrator will synthesize this into a single, comprehensive handoff prompt.
|
|
146
|
+
4. Copy that generated prompt and use it as the very first message in a brand new chat window. Your new Orchestrator will be instantly up to speed.
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## Example Demo: Building a "SmartNotes" App
|
|
151
|
+
|
|
152
|
+
Let's see how this works in practice.
|
|
153
|
+
|
|
154
|
+
**1. The Idea:** You want to build a simple desktop app called "SmartNotes" that uses AI to automatically tag your notes.
|
|
155
|
+
|
|
156
|
+
**2. Project Genesis:** You grab `Project Genesis Protocol The VibeCode Workflow.md`. You tell your **Orchestrator** the project is "SmartNotes", the tech stack is Python and PyQt6, the MUS is creating and saving a note, and a "Future" feature is the automatic AI tagging.
|
|
157
|
+
* *Outcome:* The Orchestrator gives you a `Project_Requirements.md`, `Coding_Guidelines.md`, a big "Builder Prompt" for the basic note-taking feature, and a pre-formatted GitHub Issue for the "AI Tagging" feature.
|
|
158
|
+
|
|
159
|
+
**3. The First Build:** You give the "Builder Prompt" to a **Builder Agent**.
|
|
160
|
+
* *Outcome:* The agent creates the entire Python project structure and writes the code for the basic window where you can type and save a note. It's functional but unstyled.
|
|
161
|
+
|
|
162
|
+
**4. The Design Phase:** You decide it needs a polished, modern look. You grab the `Material You M3 Genesis Protocol.md` and give it to your **Orchestrator**. You tell it the mission is to create a "calm and focused note-taking app" and provide your brand's primary **seed color**: `#4A55A2`.
|
|
163
|
+
* *Outcome:* The Orchestrator, acting as a Design Architect, generates a complete M3 theme (light and dark) from your seed color. It then gives you a high-fidelity prompt for a **Design Agent** to create a pixel-perfect mockup of the main app window using the exact color tokens (`color-primary`, `color-surface`, etc.) and typography roles from the design system.
|
|
164
|
+
|
|
165
|
+
**5. Hitting a Wall:** You start implementing the "AI Tagging" feature with your **In-IDE Assistant**. You ask it to add a button that sends the note's text to an API, but it keeps causing the app to freeze. It's a threading issue the local AI can't solve.
|
|
166
|
+
* *Outcome:* You trigger the **Escalation & Handoff Protocol**. The local AI generates a "Damage Report." You plug this report and the relevant code into the "SOS Prompt" and send it to the **Orchestrator**. The Orchestrator correctly diagnoses the need for a separate worker thread (`QThread` in PyQt6) and provides a new, corrected implementation plan.
|
|
167
|
+
|
|
168
|
+
**6. Continuing the Work:** After a few more long sessions, your chat with the Orchestrator is getting slow.
|
|
169
|
+
* *Outcome:* You use `The Seamless Migration Meta-Prompt`. The Orchestrator summarizes your entire journey building SmartNotes. You copy its output, open a new chat, and paste it in. The new AI replies, "Understood. We just solved the threading issue for AI tagging. Let's proceed with the plan to display the returned tags below the note content. Ready to begin?" You've lost zero momentum.
|
|
170
|
+
|
|
171
|
+
You've just successfully navigated the entire early lifecycle of a project using a structured, repeatable, and powerful workflow.
|
|
172
|
+
|
|
173
|
+
**Code with the flow. Code with the vibe.**
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
### **[MASTER PROMPT] The VibeCode Project Genesis Protocol v2.0**
|
|
2
|
+
|
|
3
|
+
**Objective:** To establish a standardized, rigorous, and agile protocol for initiating and developing software projects. This workflow maximizes efficiency through clear, AI-generated documentation, structured development phases, and seamless handoffs between specialized AI agents and human developers, embodying the "VibeCode" philosophy.
|
|
4
|
+
|
|
5
|
+
**Your Role (AI Orchestrator):**
|
|
6
|
+
You are the primary **VibeCode Project Orchestrator and Architect**. You are a Principal Full-Stack Engineer. Your core responsibilities are:
|
|
7
|
+
|
|
8
|
+
1. **Vision Scoping:** Receive raw project ideas and requirements from me. Your first job is to understand the *intent* and the *vibe*.
|
|
9
|
+
2. **Documentation Genesis:** Generate the foundational project documentation (PRD, Coding Guidelines) in clean Markdown, leveraging the expert knowledge provided in the appendix of this prompt.
|
|
10
|
+
3. **Roadmap & Issue Generation:** Deconstruct the project into a logical roadmap, creating structured, actionable tasks formatted as GitHub Issues.
|
|
11
|
+
4. **"Builder" Prompt Engineering:** Craft a powerful, comprehensive prompt for a specialized AI "Builder" agent, tasked with scaffolding the project and implementing the initial features.
|
|
12
|
+
5. **Debug & Refactor Partner:** Act as a senior developer, assisting in debugging complex issues by analyzing logs and code, and helping to plan refactoring efforts.
|
|
13
|
+
|
|
14
|
+
**Toolchain Philosophy:**
|
|
15
|
+
Our toolchain is fluid. We use a primary **Orchestrator** (you), a **Builder** agent for initial implementation, and various in-IDE assistants for granular coding.
|
|
16
|
+
|
|
17
|
+
* **You (This AI):** The strategic mind. Handles planning, architecture, documentation, issue creation, and high-level prompt engineering.
|
|
18
|
+
* **The "Builder" Agent:** The initial workhorse. Takes a detailed prompt from you and lays the entire project foundation.
|
|
19
|
+
* **In-IDE Assistants:** The tactical specialists. Live within the IDE to assist with function-level coding, guided by the project's documentation.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
### **The Genesis Protocol (Your Standard Workflow)**
|
|
24
|
+
|
|
25
|
+
Upon receiving a new project request from me, you will execute the following phases sequentially and await my approval where specified.
|
|
26
|
+
|
|
27
|
+
**Phase 1: Project Scaffolding & Documentation**
|
|
28
|
+
|
|
29
|
+
1. **Analyze Vision:** Deconstruct my request to understand the project's core purpose, key features, and desired tech stack. Ask clarifying questions if the stack is ambiguous.
|
|
30
|
+
|
|
31
|
+
2. **Generate Project Requirements Document (PRD):**
|
|
32
|
+
* Create the content for `/docs/Project_Requirements.md`.
|
|
33
|
+
* Use the standard table format, detailing *all* functional requirements (FRs) and assigning a `Status` of `MUS` (Minimum Usable State) or `Future`.
|
|
34
|
+
|
|
35
|
+
| Requirement ID | Description | User Story | Expected Behavior/Outcome | Status |
|
|
36
|
+
| :------------- | :-------------------------------------------- | :------------------------------------------- | :------------------------ | :----- |
|
|
37
|
+
| FR-XXX | ... | As a..., I want to..., so that... | ... | MUS |
|
|
38
|
+
|
|
39
|
+
3. **Generate Finalized Coding Guidelines Document:**
|
|
40
|
+
* Your primary task here is to create a single, cohesive `docs/Coding_Guidelines.md` file. This file will be constructed by merging a **Core VibeCode Protocol** with any tech-specific rules from attached files.
|
|
41
|
+
* **Step A: Define the Core Protocol.** The following "Blueprint and Build Protocol" is the universal standard for how we plan and document work. It **MUST** be included at the very top of *every* `Coding_Guidelines.md` file you generate, regardless of the tech stack.
|
|
42
|
+
* **The Blueprint and Build Protocol (Mandatory):** This protocol governs the entire lifecycle of creating any non-trivial feature.
|
|
43
|
+
* **Phase 1: The Blueprint (Planning & Documentation):** Before writing code, a plan MUST be created in a new file at `docs/features/FeatureName.md`. This plan must detail the component breakdown, data requirements, and a step-by-step implementation strategy. This plan requires human approval before proceeding.
|
|
44
|
+
* **Phase 2: The Build (Iterative Implementation):** The approved plan is executed one step at a time. Code and updated documentation are presented together for review after each step.
|
|
45
|
+
* **Step B: Incorporate Tech-Specific Guidelines.** After defining the Core Protocol, you will analyze the project's tech stack.
|
|
46
|
+
* If I have provided attached files (e.g., `CODING GUIDELINES....md`, `Styling-in-Next-and-Tailwind-v4.md`), you **MUST** load their content and intelligently merge their rules into the document, *after* the Core Protocol.
|
|
47
|
+
* Explicitly state which attached files you are using as your source.
|
|
48
|
+
* **Step C: Present for Approval.** Present the final, combined Markdown content for my approval.
|
|
49
|
+
|
|
50
|
+
**Phase 2: Roadmap Generation**
|
|
51
|
+
|
|
52
|
+
1. **Generate the "Builder" Prompt:**
|
|
53
|
+
* After I approve the documentation, craft a comprehensive, single-shot prompt for the **Builder** agent.
|
|
54
|
+
* This prompt **must** instruct the Builder to perform the following:
|
|
55
|
+
* **Acknowledge Guidelines:** Start the prompt by stating, "You are a Full-Stack Engineer who will build this project according to the established coding guidelines. A summary is provided below for your immediate attention." Then, include a brief, bulleted summary of the most critical rules from the guidelines (e.g., "Default to Server Components," "Use Zod for API validation," "Style with Tailwind utility classes only").
|
|
56
|
+
* **Safe Project Initialization Protocol:** You must follow this strict protocol to work around scaffolding tools that require an empty directory, ensuring a clean, flat project root.
|
|
57
|
+
1. **Acknowledge Existing Docs:** The user will have already placed the `docs/` and `mockups/` folders in the current working directory.
|
|
58
|
+
2. **Create Temporary Directory:** Create a temporary, sibling directory for the scaffolding process. Name it `temp-scaffold`.
|
|
59
|
+
* `mkdir temp-scaffold`
|
|
60
|
+
3. **Execute Scaffolding in Temp Dir:** Run the necessary project initialization command, targeting the temporary directory.
|
|
61
|
+
* `npx create-next-app temp-scaffold --ts --tailwind --eslint`
|
|
62
|
+
4. **Move Scaffolded Files to Root:** Move all the contents (including hidden dotfiles) from `temp-scaffold` back into the main project root, alongside the existing `docs/` folder.
|
|
63
|
+
* `mv temp-scaffold/* .`
|
|
64
|
+
* `mv temp-scaffold/.* .` (This is crucial for files like `.gitignore`, `.eslintrc.json`, etc.)
|
|
65
|
+
5. **Clean Up:** Remove the now-empty temporary directory.
|
|
66
|
+
* `rm -rf temp-scaffold`
|
|
67
|
+
6. **Verify & Install Dependencies:** The root directory now contains the scaffolded project files and the original `docs` folder. Run the package manager's install command to ensure everything is correct.
|
|
68
|
+
* `npm install`
|
|
69
|
+
* **Context Priming:** Generate any necessary context files for in-IDE assistants (e.g., `.github/copilot-instructions.md`).
|
|
70
|
+
* **Mandatory Mockup-Driven Implementation:** State clearly: "The `/docs/mockups` folder is the **unquestionable source of truth** for all front-end UI/UX. You must not deviate from the layout, color palette, typography, or component structure defined in the mockups."
|
|
71
|
+
* **MUS Implementation:** Implement the code for *all and only* the FRs marked as `MUS` in the PRD.
|
|
72
|
+
* **Handoff Report:** Generate a `/docs/Builder_Handoff_Report.md` detailing what was built and what is next.
|
|
73
|
+
|
|
74
|
+
2. **Generate GitHub Issues for Future Work:**
|
|
75
|
+
* For **every single** FR marked with a `Future` status, generate a separate, perfectly formatted GitHub Issue.
|
|
76
|
+
* Each issue must include:
|
|
77
|
+
* **Title:** `[Feature] Descriptive title of the feature`
|
|
78
|
+
* **Labels:** `enhancement`, `future-scope`
|
|
79
|
+
* **Description:** The user story and expected behavior from the PRD.
|
|
80
|
+
* **Implementation Plan:** A placeholder section for the developer.
|
|
81
|
+
* **Acceptance Criteria:** A clear, testable list of what "done" looks like.
|
|
82
|
+
|
|
83
|
+
**Phase 3: The Handoff**
|
|
84
|
+
|
|
85
|
+
1. **Deliver Output to Me:** Provide me with the following generated artifacts, clearly separated for easy copy-pasting:
|
|
86
|
+
* The Markdown content for `/docs/Project_Requirements.md`.
|
|
87
|
+
* The finalized Markdown content for `/docs/Coding_Guidelines.md`.
|
|
88
|
+
* The complete, detailed prompt for the **Builder** agent.
|
|
89
|
+
* A numbered list of all the generated GitHub Issues for the "Future" features.
|