-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.cursorrules
More file actions
430 lines (286 loc) · 7.95 KB
/
Copy path.cursorrules
File metadata and controls
430 lines (286 loc) · 7.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# 🎯 AI CODING WORKFLOWS - MANDATORY
When receiving a coding request, AI MUST:
1. **Identify task type**: Bug-Fix or Feature?
2. **Follow the corresponding workflow**
3. **DO NOT skip any phase**
> **Language Note**: These workflows work with any language input
---
# 🐛 WORKFLOW 1: BUG-FIX
> **Use when**: Fix bugs, resolve errors, debug issues
## FLOW
```
INPUT → RESEARCH (find cause, NO fixes) → PLAN (propose fix) → HUMAN REVIEW → IMPLEMENT
```
---
## 📥 PHASE 0: INPUT
Request user to provide:
1. Relevant files only (not entire codebase)
2. Brief error description (error message, log, behavior)
3. Expected result
---
## 🔍 PHASE 1: RESEARCH (Detective)
**Goal**: Read code & logs, find root cause
**⚠️ DO NOT FIX anything in this phase**
### Output format:
```markdown
## 🔍 RESEARCH RESULTS
### Root Cause Found:
- [Describe the cause]
### Related Files:
- [List of files to modify]
### Complexity: [Low/Medium/High]
```
---
## 📐 PHASE 2: PLAN (Architect)
**Goal**: Propose step-by-step solution, list all changes
**⚠️ STILL NO CODE in this phase**
### Output format:
```markdown
## 📐 IMPLEMENTATION PLAN
### Solution Overview:
[Brief description of approach]
### Steps:
1. [ ] [Step 1] - [Related file]
2. [ ] [Step 2] - [Related file]
3. [ ] [Step 3] - [Related file]
### Potential Risks:
- [Risk 1 and mitigation]
### Verification:
- [How to verify the fix]
```
---
## 🚦 CHECKPOINT: HUMAN REVIEW
### ⚠️ MUST STOP HERE AND WAIT FOR USER APPROVAL
**Mental Alignment** - Ensure mutual understanding before proceeding!
### Output format:
```markdown
## 🚦 PERMISSION TO PROCEED
I've completed my analysis and have a plan as shown above.
✅ Confirm to start implementation?
❌ Any adjustments needed?
```
### Rules:
- WAIT for user reply - Do not implement on your own
- If user provides feedback - Return to Phase 2 to adjust plan
---
## 🛠️ PHASE 3: IMPLEMENT (Builder)
**Prerequisite**: User has approved plan
**Goal**: Code runs smoothly, "first time right"
### Steps:
1. Implement according to approved plan
2. Self-verify (build/lint/test)
3. Report completion
### Output format:
```markdown
## ✅ IMPLEMENTATION COMPLETE
### Completed:
- [x] [Step 1]
- [x] [Step 2]
### Modified Files:
- `path/to/file1.ts` - [Description of change]
### Verification:
- [Test/build results]
### Next Steps (if any):
- [What user needs to do next]
```
---
# 🎨 WORKFLOW 3: UI/UX DESIGN (Frontend)
> **Use when**: "Make it pretty", "Design ideas", "UI/UX brainstorming", "Improve aesthetics"
## FLOW
```
INSPIRATION → BRAINSTORMING → MOCKUP → HUMAN REVIEW → STRATEGY
```
---
## 📥 PHASE 0: INPUT
Request:
1. **Vibe/Aesthetics** (Modern, Minimal, etc.)
2. **Target Audience**
3. **Inspiration** (Similar apps/sites)
---
## 🔍 PHASE 1: DISCOVERY & BRAINSTORMING
**Goal**: Propose options, colors, and layout ideas.
### Output format:
```markdown
## 🎨 DESIGN CONCEPTS
### Recommended Style:
- [Describe style, e.g., Glassmorphism]
- Color Palette: [Hex codes]
### Option A: [Name]
- Layout: [Description]
- Pros/Cons: [...]
### Option B: [Name]
- Layout: [Description]
- Pros/Cons: [...]
### ✨ Wow Factor:
- [Micro-interaction idea]
```
---
## 🚦 CHECKPOINT: DESIGN REVIEW
### ⚠️ MUST STOP AND WAIT FOR USER PREFERENCE
```markdown
## 🚦 DESIGN FEEDBACK
Which option do you prefer? Any changes to colors/vibe?
```
---
## 📝 PHASE 2: DETAILED MOCKUP
**Goal**: Clear structure before coding
### Output format:
```markdown
## 🖼️ VISUAL STRUCTURE (Wireframe)
[ASCII or Text Description of Layout]
### Component Specs:
- Shadows, Borders, Typography settings
```
---
## ⚡ QUICK REFERENCE
| Phase | Allowed | NOT Allowed |
|-------|---------|-------------|
| Research | ✅ Read code, trace bugs | ❌ Modify code |
| Plan | ✅ Write plan, propose | ❌ Modify code |
| Review | ✅ Ask, clarify | ❌ Implement without approval |
| Implement | ✅ Write code | ❌ Work outside scope |
---
## 🎨 STYLE GUIDELINES
### Code Quality
- Write clean, readable code
- Follow existing code conventions in project
- Add comments for complex logic
- Handle edge cases
### Communication
- Match user's language
- Be concise, get to the point
- If unsure, ASK instead of guessing
---
# 🚀 WORKFLOW 2: FEATURE DEVELOPMENT
> **Use when**: Create new features, add components, build new modules
## FLOW
```
INPUT → RESEARCH (survey patterns) → DESIGN (architecture) → HUMAN REVIEW → IMPLEMENT
```
---
## 📥 PHASE 0: INPUT
Request user to provide:
1. **Feature description** - What does this feature do?
2. **User story** - Who uses it? How?
3. **Acceptance criteria** - When is it considered complete?
---
## 🔍 PHASE 1: RESEARCH (Survey)
**Goal**: Understand codebase, find existing patterns, identify reusable code
**⚠️ NO CODE in this phase**
### Output format:
```markdown
## 🔍 RESEARCH RESULTS
### Codebase Overview:
- Tech stack: [Next.js, React, etc.]
- UI Library: [HeroUI, Tailwind, etc.]
### Patterns Found:
- [Pattern 1]: [Description]
### Reusable Code:
- `path/to/component.tsx` - [Description]
### Complexity: [Low/Medium/High]
```
---
## 📐 PHASE 2: DESIGN (Architect)
**Goal**: Design architecture, component structure, data flow
**⚠️ NO CODE in this phase**
### Output format:
```markdown
## 📐 FEATURE DESIGN
### Architecture:
[Folder structure, files to create]
### Component Breakdown:
1. `ComponentName` - [Purpose, props]
2. `useHookName` - [Purpose, returns]
### Implementation Steps:
1. [ ] [Step 1] - [File]
2. [ ] [Step 2] - [File]
### Edge Cases:
- [Edge case 1] - [How to handle]
```
---
## 🚦 CHECKPOINT: HUMAN REVIEW
### ⚠️ MUST STOP AND WAIT FOR USER APPROVAL
```markdown
## 🚦 DESIGN REVIEW
I've completed the architecture design as shown above.
✅ Confirm design to start implementation?
❌ Any adjustments needed?
```
---
## 🛠️ PHASE 3: IMPLEMENT (Build)
**Prerequisite**: User has approved design
### Implementation Order:
1. Foundation (types, base components, hooks)
2. Build up (composite components, integration)
3. Polish (error handling, loading states, animations)
### Output format:
```markdown
## ✅ FEATURE IMPLEMENTATION COMPLETE
### Created:
- [x] `src/components/Feature/index.tsx`
- [x] `src/hooks/useFeature.ts`
### Usage:
```tsx
import { Feature } from '@/components/Feature';
<Feature prop="value" />
```
### Demo/Test:
[How to test the feature]
```
---
---
# 🎨 WORKFLOW 3: UI/UX DESIGN (Frontend)
> **Use when**: "Make it pretty", "Design ideas", "UI/UX brainstorming", "Improve aesthetics"
## FLOW
```
INSPIRATION → BRAINSTORMING → MOCKUP → HUMAN REVIEW → STRATEGY
```
---
## 📥 PHASE 0: INPUT
Request:
1. **Vibe/Aesthetics** (Modern, Minimal, etc.)
2. **Target Audience**
3. **Inspiration** (Similar apps/sites)
---
## 🔍 PHASE 1: DISCOVERY & BRAINSTORMING
**Goal**: Propose options, colors, and layout ideas.
### Output format:
```markdown
## 🎨 DESIGN CONCEPTS
### Recommended Style:
- [Describe style, e.g., Glassmorphism]
- Color Palette: [Hex codes]
### Option A: [Name]
- Layout: [Description]
- Pros/Cons: [...]
### Option B: [Name]
- Layout: [Description]
- Pros/Cons: [...]
### ✨ Wow Factor:
- [Micro-interaction idea]
```
---
## 🚦 CHECKPOINT: DESIGN REVIEW
### ⚠️ MUST STOP AND WAIT FOR USER PREFERENCE
```markdown
## 🚦 DESIGN FEEDBACK
Which option do you prefer? Any changes to colors/vibe?
```
---
## 📝 PHASE 2: DETAILED MOCKUP
**Goal**: Clear structure before coding
### Output format:
```markdown
## 🖼️ VISUAL STRUCTURE (Wireframe)
[ASCII or Text Description of Layout]
### Component Specs:
- Shadows, Borders, Typography settings
```
---
# 📋 QUICK DECISION: WHICH WORKFLOW?
| User Request | Workflow |
|--------------|----------|
| "Fix bug...", "Error...", "Issue..." | 🐛 Bug-Fix |
| "Add feature...", "Logic...", "Backend..." | 🚀 Feature |
| "Make it pretty...", "Design...", "UI ideas...", "Brainstorm layout..." | 🎨 UI/UX Design |
| Unclear | **ASK USER** before starting |