cursor-rules

Cursor Rules Management Guide

Rule Structure Format

Every cursor rule must follow this exact metadata and content 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

Example:
```typescript
// Good
function goodExample() {
  // Correct implementation
}

// Bad example
function badExample() {
  // Incorrect implementation
}
```

File Organization

Required Location

All cursor rule files must be placed in:

PROJECT_ROOT/.cursor/rules/

Directory Structure

PROJECT_ROOT/
├── .cursor/
│   └── rules/
│       ├── your-rule-name.mdc
│       ├── another-rule.mdc
│       └── cursor-rules.mdc
└── ...

Naming Conventions

• Use kebab-case for all filenames
• Always use .mdc extension
• Make names descriptive of the rule's purpose
• Examples: typescript-style.mdc, tailwind-styling.mdc, mdx-documentation.mdc

Content Guidelines

Writing Effective Rules

1. Be specific and actionable - Provide clear instructions
2. Include code examples - Show both good and bad practices
3. Reference existing files - Use @filename.ext format
4. Keep it focused - One rule per concern/pattern
5. Add context - Explain why the rule exists

Code Examples Format

// ✅ Good: Clear and follows conventions
function processUser({ id, name }: { id: string; name: string }) {
  return { id, displayName: name };
}

// ❌ Bad: Unclear parameter passing
function processUser(id: string, name: string) {
  return { id, displayName: name };
}

File References

When referencing project files in rules, use this pattern to mention other files:

[file.tsx](mdc:path/to/file.tsx)

Forbidden Locations

Never place rule files in:

• Project root directory
• Any subdirectory outside .cursor/rules/
• Component directories
• Source code folders
• Documentation folders