.cursorrules (deprecated)

1// Awesome CursorRules
2// A curated list of awesome .cursorrules files for enhancing Cursor AI experience
3 
4// General guidelines
5Always use Markdown for documentation and README files
6Maintain the existing structure of the README.md file
7 
8// README.md structure
9Maintain the following structure in the README.md file:
10  1. Title and Awesome badge
11  2. Logo
12  3. Short description
13  4. "Why .cursorrules?" section
14  5. Table of Contents
15  6. Rules section
16     - Frontend Frameworks and Libraries
17     - Backend and Full-Stack
18     - Mobile Development
19     - CSS and Styling
20     - State Management
21     - Database and API
22     - Testing
23     - Build Tools and Development
24     - Language-Specific
25     - Other
26  7. How to Use section
27  8. Contributing section
28  9. License section
29 
30// Organization of rules
31Organize .cursorrules files into the following main categories within the 'rules' directory:
32  - Frontend Frameworks and Libraries
33  - Backend and Full-Stack
34  - Mobile Development
35  - CSS and Styling
36  - State Management
37  - Database and API
38  - Testing
39  - Build Tools and Development
40  - Language-Specific
41  - Other
42Place each .cursorrules file directly in the 'rules' folder
43The folder name for each .cursorrules file should describe the category and content of the file
44Refer to the README in each folder for guidance on naming conventions and descriptions
45 
46// Naming and formatting
47Use descriptive names for .cursorrules files and their folders, following the pattern: 'technology-focus-cursorrules-prompt-file'
48Maintain alphabetical order within each category in the README.md file
49Use consistent formatting for list items in the README.md file
50 
51// Content guidelines
52When creating or editing .cursorrules files, focus on project-specific instructions and best practices
53Include comments in .cursorrules files to explain complex rules or provide context
54Use clear and concise language in all documentation and .cursorrules files
55Provide context on what you're building, style guidelines, or info on commonly-used methods
56 
57// Optional README for credit and description
58Each .cursorrules file may have an accompanying README.md file in its folder
59Use this README to provide credit to the original author and a brief description of the .cursorrules file's purpose
60 
61// Maintenance and updates
62Update the README.md file when adding new .cursorrules files, placing them in the correct category
63Ensure all links in the README.md file are relative and correct
64When updating the README.md, ensure the table of contents remains accurate
65When adding new categories, update both the 'Contents' and 'Rules' sections of the README.md
66Regularly review and update categorization as the repository grows
67 
68// Best practices
69Maintain consistency in capitalization and punctuation throughout the repository
70When referencing Cursor AI, always use the correct capitalization and spacing
71When adding examples or explanations, focus on practical use cases for Cursor AI users
72If a .cursorrules file fits multiple categories, place it in the most relevant one and cross-reference in others if necessary
73Keep the 'Other' category for .cursorrules files that don't fit neatly into the main categories
74 
75// Additional insights
76.cursorrules files are repo-specific "Rules for AI"
77.cursorrules files should be placed in the root of the repository
78The content of .cursorrules files will be appended to the global "Rules for AI" settings in Cursor
79Focus on providing repo-level context and guidelines, not just general coding practices
80.cursorrules can include information about project structure, architectural decisions, and commonly used libraries or methods
81Consider including rules for handling specific file types or coding patterns unique to your project
82Rules can cover both code generation and code understanding aspects for Cursor AI