Cursor rule

1---
2description: Template for defining project context
3globs: README.md, /docs/*
4---
5# Comprehensive Project Definition Template
6 
7This rule enforces best practices for documenting project context, ensuring clarity and maintainability through well-documented README files and documentation.
8 
9<rule>
10name: comprehensive_project_definition
11description: Enforce comprehensive project context definition for CursorAI
12filters:
13  - type: file_extension
14    pattern: "\\.md$"
15  - type: file_path
16    pattern: "README.md|/docs/"
17 
18actions:
19  - type: enforce
20    conditions:
21      - pattern: "## Project Purpose"
22        message: "Define the purpose of the project in the README file, including its goals and objectives."
23 
24      - pattern: "## Technical Stack"
25        message: "List the technical stack used in the project in the README file, including language versions and frameworks."
26 
27      - pattern: "## Folder Structure"
28        message: "Document the folder structure in the README file with a brief explanation for each significant directory."
29 
30      - pattern: "## Customizations"
31        message: "Include any custom themes, modules, or libraries in the README file, explaining their functionality."
32 
33      - pattern: "## Libraries"
34        message: "List any third-party libraries used in the project in the README file, including versions for reproducibility."
35 
36      - pattern: "## Setup Instructions"
37        message: "Provide clear setup instructions in the README to help new contributors or users get started."
38 
39      - pattern: "## Contribution Guidelines"
40        message: "Document contribution guidelines if the project is open-source or team-based."
41 
42  - type: suggest
43    message: |
44      **Project Definition Best Practices:**
45      - **README and Docs:** Use both README.md for an overview and /docs/ for detailed documentation.
46      - **Project Purpose:** Clearly articulate why the project exists, its objectives, and who it serves.
47      - **Technical Stack:** Include all technologies, versions, and possibly why each was chosen.
48      - **Folder Structure:** Use tree diagrams or simple bullet points to describe the project's layout.
49      - **Customizations:** Explain any custom code, including its purpose and how it integrates with the project.
50      - **Libraries:** Detail external dependencies, why they're used, and how to manage them (e.g., npm, composer).
51      - **Setup Instructions:** Provide step-by-step guidance for setting up the project environment.
52      - **Contribution Guidelines:** Outline how to contribute, including coding standards, branch management, and pull request process.
53      - **License:** Include information about the project's licensing for legal clarity.
54      - **Roadmap:** Optionally, add a roadmap section to discuss future plans or features.
55 
56  - type: validate
57    conditions:
58      - pattern: "## Project Purpose"
59        message: "Ensure the project purpose is clearly defined for understanding the project's intent."
60 
61      - pattern: "## Technical Stack"
62        message: "Ensure the technical stack is documented to aid in tech stack comprehension."
63 
64      - pattern: "## Folder Structure"
65        message: "Ensure the folder structure is outlined for navigation ease."
66 
67      - pattern: "## Customizations"
68        message: "Ensure customizations are documented for understanding unique project elements."
69 
70      - pattern: "## Libraries"
71        message: "Ensure libraries are listed for dependency management."
72 
73      - pattern: "## Setup Instructions"
74        message: "Ensure setup instructions are included to facilitate onboarding."
75 
76metadata:
77  priority: medium
78  version: 1.1
79</rule>