| name | cursor-rules |
| description | How to add or edit Cursor rules in our project |
Cursor Rules Location
How to add new cursor rules to the project
-
Always place rule files in PROJECT_ROOT/.cursor/rules/:
.cursor/rules/
├── your-rule-name.mdc
├── another-rule.mdc
└── ...
-
Follow the naming convention:
- Use kebab-case for filenames
- Always use .mdc extension
- Make names descriptive of the rule's purpose
-
Directory structure:
PROJECT_ROOT/
├── .cursor/
│ └── rules/
│ ├── your-rule-name.mdc
│ └── ...
└── ...
-
Never place rule files:
- In the project root
- In subdirectories outside .cursor/rules
- In any other location
-
Cursor rules have the following structure:
---
description: Short description of the rule's purpose
globs: optional/path/pattern/**/*
alwaysApply: false
---
# Rule Title
Main content explaining the rule with markdown formatting.
1. Step-by-step instructions
2. Code examples
3. Guidelines