AgentSkillsCN

cursor-rules

如何在我们的项目中添加或编辑 Cursor 规则

SKILL.md
--- frontmatter
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

  1. Always place rule files in PROJECT_ROOT/.cursor/rules/:

    code
    .cursor/rules/
    ├── your-rule-name.mdc
    ├── another-rule.mdc
    └── ...
    
  2. Follow the naming convention:

    • Use kebab-case for filenames
    • Always use .mdc extension
    • Make names descriptive of the rule's purpose
  3. Directory structure:

    code
    PROJECT_ROOT/
    ├── .cursor/
    │   └── rules/
    │       ├── your-rule-name.mdc
    │       └── ...
    └── ...
    
  4. Never place rule files:

    • In the project root
    • In subdirectories outside .cursor/rules
    • In any other location
  5. Cursor rules have the following structure:

code
---
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 example
function goodExample() {
  // Implementation following guidelines
}

// Bad example
function badExample() {
  // Implementation not following guidelines
}
```