forked from steipete/agent-rules
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontinuous-improvement.mdc
More file actions
296 lines (227 loc) · 6.28 KB
/
continuous-improvement.mdc
File metadata and controls
296 lines (227 loc) · 6.28 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
---
description: Systematic approach for continuously improving AI assistant rules based on emerging patterns and best practices
globs: ""
alwaysApply: false
---
# Continuous Improvement Guide for AI Development Rules
This guide provides a systematic approach for continuously improving AI assistant rules based on emerging patterns, best practices, and lessons learned during development.
## Rule Improvement Triggers
### When to Create or Update Rules
**Create New Rules When:**
- A new technology/pattern is used in 3+ files
- Common bugs could be prevented by a rule
- Code reviews repeatedly mention the same feedback
- New security or performance patterns emerge
- A complex task requires consistent approach
**Update Existing Rules When:**
- Better examples exist in the codebase
- Additional edge cases are discovered
- Related rules have been updated
- Implementation details have changed
- User feedback indicates confusion
## Analysis Process
### 1. Pattern Recognition
Monitor your codebase for repeated patterns:
```typescript
// Example: If you see this pattern repeatedly:
const data = await prisma.user.findMany({
select: { id: true, email: true },
where: { status: 'ACTIVE' }
});
// Consider documenting:
// - Standard select fields
// - Common where conditions
// - Performance optimization patterns
```
### 2. Error Pattern Analysis
Track common mistakes and their solutions:
```yaml
Common Error: "Connection timeout"
Root Cause: Missing strategic delay after service startup
Solution: Add 5-10 second delay after launching services
Rule Update: Add timing guidelines to automation rules
```
### 3. Best Practice Evolution
Document emerging best practices:
```markdown
## Before (Old Pattern)
- Direct DOM manipulation
- No error handling
- Synchronous operations
## After (New Pattern)
- Use framework methods
- Comprehensive error handling
- Async/await with proper error boundaries
```
## Rule Quality Framework
### Structure Guidelines
Each rule should follow this structure:
```markdown
# Rule Name
## Purpose
Brief description of what this rule achieves
## When to Apply
- Specific scenarios
- Trigger conditions
- Prerequisites
## Implementation
### Basic Pattern
```code
// Minimal working example
```
### Advanced Pattern
```code
// Complex scenarios with error handling
```
## Common Pitfalls
- Known issues
- How to avoid them
## References
- Related rules: [rule-name.md]
- External docs: [link]
```
### Quality Checklist
Before publishing a rule, ensure:
- [ ] **Actionable**: Provides clear, implementable guidance
- [ ] **Specific**: Avoids vague recommendations
- [ ] **Tested**: Examples come from working code
- [ ] **Complete**: Covers common edge cases
- [ ] **Current**: References are up to date
- [ ] **Linked**: Cross-references related rules
## Continuous Improvement Workflow
### 1. Collection Phase
**Daily Development**
- Note repeated code patterns
- Document solved problems
- Track tool usage patterns
**Weekly Review**
- Analyze git commits for patterns
- Review debugging sessions
- Check error logs
### 2. Analysis Phase
**Pattern Extraction**
```python
# Pseudo-code for pattern analysis
patterns = analyze_codebase()
for pattern in patterns:
if pattern.frequency >= 3 and not documented(pattern):
create_rule_draft(pattern)
```
**Impact Assessment**
- How many files would benefit?
- What errors would be prevented?
- How much time would be saved?
### 3. Documentation Phase
**Rule Creation Process**
1. Draft initial rule with examples
2. Test rule on existing code
3. Get feedback from team
4. Refine and publish
5. Monitor effectiveness
### 4. Maintenance Phase
**Regular Updates**
- Monthly: Review rule usage
- Quarterly: Major updates
- Annually: Deprecation review
## Meta-Rules for Rule Management
### Rule Versioning
```yaml
rule_version: 1.2.0
last_updated: 2024-01-15
breaking_changes:
- v1.0.0: Initial release
- v1.1.0: Added error handling patterns
- v1.2.0: Updated for new framework version
```
### Deprecation Process
```markdown
## DEPRECATED: Old Pattern
**Status**: Deprecated as of v2.0.0
**Migration**: See [new-pattern.md]
**Removal Date**: 2024-06-01
[Original content preserved for reference]
```
### Rule Metrics
Track rule effectiveness:
```yaml
metrics:
usage_count: 45
error_prevention: 12 bugs avoided
time_saved: ~3 hours/week
user_feedback: 4.2/5
```
## Example: Self-Improving Rule System
### Automated Rule Suggestions
```typescript
// Monitor code patterns
interface RuleSuggestion {
pattern: string;
frequency: number;
files: string[];
suggestedRule: string;
}
// Generate suggestions
function analyzeForRules(codebase: Codebase): RuleSuggestion[] {
// Implementation
}
```
### Feedback Loop Integration
```yaml
# In your project's .cursor/rules/feedback.yaml
feedback_enabled: true
feedback_channel: "#ai-rules"
suggestion_threshold: 3
auto_create_draft: true
```
## Best Practices for Rule Evolution
### 1. Start Simple
- Begin with minimal viable rules
- Add complexity based on real needs
- Avoid over-engineering
### 2. Learn from Failures
- Document what didn't work
- Understand why it failed
- Share lessons learned
### 3. Encourage Contributions
- Make it easy to suggest improvements
- Provide templates for new rules
- Recognize contributors
### 4. Measure Impact
- Track before/after metrics
- Collect user testimonials
- Quantify time savings
## Integration with Development Workflow
### Git Hooks
```bash
#!/bin/bash
# pre-commit hook to check rule compliance
./scripts/check-rules.sh
```
### CI/CD Pipeline
```yaml
# .github/workflows/rules.yml
name: Rule Compliance Check
on: [push, pull_request]
jobs:
check-rules:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: npm run check:rules
```
### IDE Integration
```json
// .vscode/settings.json
{
"cursor.rules.autoSuggest": true,
"cursor.rules.path": ".cursor/rules",
"cursor.rules.checkOnSave": true
}
```
## Conclusion
Continuous improvement of AI development rules is an iterative process that requires:
- Active monitoring of development patterns
- Regular analysis and documentation
- Community feedback and collaboration
- Systematic maintenance and updates
By following this guide, teams can build a living knowledge base that evolves with their codebase and continuously improves developer productivity.