Cursor Rules

A collection of standardized development rules and best practices for projects built with the Cursor IDE.

Getting Started • Documentation • Contributing • Security •

📋 Overview

Cursor Rules is a community-driven collection of AI behavior rules that help teams maintain consistency and quality across their projects. By providing semantic descriptions for different file types and development patterns, these rules enable Cursor's AI to better understand your codebase and provide more relevant assistance.

Key Features

• 🎯 Project-Specific Rules: Configure AI behavior for different parts of your project
• 🔄 Context-Aware: Rules are automatically applied based on file patterns
• 📦 Reusable: Share rules across projects and teams
• 🛠️ Customizable: Adapt rules to your specific needs and preferences

🚀 Getting Started

Prerequisites

• Cursor IDE installed
• Git

Installation

1. Add this repository to your project:

   git submodule add https://github.com/drengskapur/.cursor

📖 Documentation

Structure

Rules are stored in the .cursor/rules directory and provide semantic descriptions for:

• File pattern matching
• Auto-generated code handling
• Development patterns
• Architecture guidelines

Creating Rules

Create new rules using the Cursor command palette:

1. Press Cmd + Shift + P (Mac) or Ctrl + Shift + P (Windows/Linux)
2. Type "New Cursor Rule"
3. Follow the prompts

Available Categories

• Authentication: Security and authentication patterns
• Framework: Application architecture and patterns
• Testing: Unit, integration, and E2E testing standards
• UI: Component architecture and documentation
• Automation: Development workflows
• State: Application state management

Rule Format

Each rule set includes:

• Best practices and conventions
• Code snippets and examples
• Configuration templates
• Common patterns and anti-patterns

🤝 Contributing

We believe in the power of community collaboration. Whether you're fixing bugs, adding new rules, or improving documentation, your contributions are welcome!

See our Contributing Guide for details on:

• Code of Conduct
• Development process
• Pull request guidelines
• Rule creation guidelines

💬 Community

• GitHub Issues for bug reports and feature requests
• GitHub Discussions for questions and discussions
• Pull Requests for contributions
• Security Policy for vulnerability reporting

🔒 Security

We take the security of Cursor Rules seriously. If you believe you have found a security vulnerability, please read our Security Policy for reporting guidelines.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.