Created
June 27, 2025 04:04
-
-
Save greatSumini/1c3974bb79934c48043bdbc92c2197ff to your computer and use it in GitHub Desktop.
Cursor Rule 작성 Rule
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--- | |
description: | |
globs: | |
alwaysApply: false | |
--- | |
- **Required Rule Structure:** | |
```markdown | |
--- | |
description: Clear, one-line description of what the rule enforces | |
globs: path/to/files/*.ext, other/path/**/* | |
alwaysApply: boolean | |
--- | |
- **Main Points in Bold** | |
- Sub-points with details | |
- Examples and explanations | |
``` | |
- **File References:** | |
- Use `[filename](mdc:path/to/file)` ([filename](mdc:filename)) to reference files | |
- Example: [prisma.mdc](mdc:.cursor/rules/prisma.mdc) for rule references | |
- Example: [schema.prisma](mdc:prisma/schema.prisma) for code references | |
- **Code Examples:** | |
- Use language-specific code blocks | |
```typescript | |
// ✅ DO: Show good examples | |
const goodExample = true; | |
// ❌ DON'T: Show anti-patterns | |
const badExample = false; | |
``` | |
- **Rule Content Guidelines:** | |
- Write in english | |
- Use prompt engineering techniques | |
- Start with high-level overview | |
- Include specific, actionable requirements | |
- Show examples of correct implementation | |
- Reference existing code when possible | |
- Keep rules DRY by referencing other rules | |
- **Rule Maintenance:** | |
- Update rules when new patterns emerge | |
- Add examples from actual codebase | |
- Remove outdated patterns | |
- Cross-reference related rules | |
- **Best Practices:** | |
- Use bullet points for clarity | |
- Keep descriptions concise | |
- Include both DO and DON'T examples | |
- Reference actual code over theoretical examples | |
- Use consistent formatting across rules |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment