40 lines
1.9 KiB
Plaintext
40 lines
1.9 KiB
Plaintext
---
|
|
description:
|
|
globs:
|
|
alwaysApply: false
|
|
---
|
|
# Cursor Rules Automated Installation & Configuration Guide
|
|
|
|
You are to follow these instructions after this `rules` folder has been copied into the project's `.cursor` directory. Your goal is to configure and adapt the rules for this specific project with minimal manual intervention.
|
|
|
|
## 1. Review Rule Files
|
|
- Read all `.mdc` files in `.cursor/rules`.
|
|
- Identify any rules that are not relevant to this project's framework, language, or domain.
|
|
- List which files should be removed, renamed, or adapted, and propose new rules if needed.
|
|
|
|
## 2. Adaptation
|
|
- For each rule that requires adaptation (e.g., framework-specific best practices), generate a new `.mdc` file (e.g., `best-practices-react.mdc`, `best-practices-python.mdc`) with appropriate content.
|
|
- Remove or archive irrelevant rules (e.g., Astro-specific rules in a non-Astro project).
|
|
- If the project is not web-based, create domain-specific rules (e.g., `cli-ux.mdc`, `api-design.mdc`, `data-best-practices.mdc`).
|
|
|
|
## 3. Project-Specific Customization
|
|
- Analyze the project structure and requirements.
|
|
- Create a `project-adaptations.mdc` file summarizing any overrides, extensions, or exceptions to the default rules.
|
|
- Document all changes and the reasoning behind them.
|
|
|
|
## 4. Documentation
|
|
- Update `.cursor/README.md` to summarize all rule adaptations, removals, and additions.
|
|
- Clearly state which rules are overridden, ignored, or extended for this project.
|
|
|
|
## 5. Maintenance
|
|
- When the central rules are updated, re-read all `.mdc` files in `.cursor/rules`.
|
|
- Re-apply project-specific adaptations and update documentation as needed.
|
|
- Alert the user if any manual review is required due to conflicts or ambiguities.
|
|
|
|
---
|
|
|
|
**General Principle:**
|
|
- Automate as much of the review, adaptation, and documentation process as possible.
|
|
- Only request user input if clarification or conflict resolution is required.
|
|
|