Skip to content

Commit 1c22517

Browse files
committed
docs: update readme with rule types
1 parent 65e54c9 commit 1c22517

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,29 +29,33 @@ Our Cursor rules system, inspired by [cursor-auto-rules-agile-workflow](https://
2929

3030
### Rule Categories
3131

32-
- **000-cursor-rules**: Core rule format and management
33-
- **400-md-docs**: Markdown documentation standards
34-
- **901-commit-message**: Git commit message formatting
35-
- **902-arch**: Architecture documentation standards
36-
- **903-story**: User story templates
37-
- **904-lessons**: Knowledge retention system
38-
- **905-pr-creation**: Pull request standards
39-
- **906-prd**: Product requirement documents
32+
- **core-rules**: Core rule format and management, foundational rules for the system
33+
- **documentation**: Documentation standards and formatting rules
34+
- **global-rules**: Global rules that apply across all contexts
35+
- **tool-rules**: Tool-specific rules and configurations
36+
- **workflows**: Workflow templates and process standards
4037

4138
### Rule Structure
4239

4340
Each rule follows a standardized format:
4441

4542
```yaml
4643
---
47-
description: ACTION when TRIGGER to OUTCOME
48-
globs: pattern to match files
49-
tags: [categorization tags]
50-
priority: 1-5
51-
version: Major.Minor.Patch
44+
name: Name of the rule
45+
description: ACTION when TRIGGER to OUTCOME # Critical for agent-selected rules, blank for others
46+
globs: pattern to match files # Critical glob pattern for auto rules, blank for others
47+
alwaysApply: true|false # Determines if rule is applied to every request
5248
---
5349
```
5450

51+
#### Rule Types
52+
53+
- **Agent Selected**: Agent sees description and chooses when to apply
54+
- **Always**: Applied to every chat and cmd-k request
55+
- **Auto Select**: Applied to matching existing files
56+
- **Auto Select+desc**: Better for new files, includes description
57+
- **Manual**: User must reference in chat
58+
5559
## 🚀 Getting Started
5660

5761
1. **Clone the Repository**

0 commit comments

Comments
 (0)