|
| 1 | +# Cursor Rules Structure |
| 2 | + |
| 3 | +This directory contains optimized rules for Cursor AI assistance in the SubZilla project. |
| 4 | + |
| 5 | +## 📁 Rule Files |
| 6 | + |
| 7 | +### `subzilla-essentials.mdc` |
| 8 | + |
| 9 | +Main development rules covering: |
| 10 | + |
| 11 | +- Core execution principles (SEARCH FIRST, REUSE PATTERNS) |
| 12 | +- Architecture patterns and monorepo structure |
| 13 | +- TypeScript conventions |
| 14 | +- Development workflow |
| 15 | + |
| 16 | +### `ai-corrections.mdc` |
| 17 | + |
| 18 | +Specific corrections for common AI mistakes: |
| 19 | + |
| 20 | +- Prevents unnecessary file creation |
| 21 | +- Enforces emoji logging |
| 22 | +- Blocks skeleton code generation |
| 23 | +- Maintains existing patterns |
| 24 | + |
| 25 | +### `quick-reference.mdc` |
| 26 | + |
| 27 | +Copy-paste examples for: |
| 28 | + |
| 29 | +- Service class patterns |
| 30 | +- CLI command structure |
| 31 | +- Import conventions |
| 32 | +- Error handling templates |
| 33 | + |
| 34 | +## 🚀 Usage |
| 35 | + |
| 36 | +These rules are automatically loaded by Cursor based on file globs: |
| 37 | + |
| 38 | +- `subzilla-essentials.mdc`: Manual reference (not always applied) |
| 39 | +- `ai-corrections.mdc`: Always applied to prevent common mistakes |
| 40 | +- `quick-reference.mdc`: Manual reference for code examples |
| 41 | + |
| 42 | +## 📝 Maintenance |
| 43 | + |
| 44 | +- Keep rules focused on AI behavior, not documentation |
| 45 | +- Update `ai-corrections.mdc` when noticing repeated AI mistakes |
| 46 | +- Add new patterns to `quick-reference.mdc` as they emerge |
| 47 | +- Review quarterly and remove outdated rules |
| 48 | + |
| 49 | +## 🔄 Migration |
| 50 | + |
| 51 | +Old verbose rules are backed up in `.cursor/rules.backup/` if needed for reference. |
0 commit comments