d176e40726
# refactor: restructure .cursor directory for improved organization and clarity ## Description This PR refactors the `.cursor` directory to enhance organization, clarity, and maintainability. ### Problem The existing `.cursor` directory lacked clear organization, making it difficult to find specific files, understand their purpose, and add new components consistently. ### Solution A comprehensive restructuring: #### New Directory Structure ``` .cursor/ ├── settings.json # Main configuration file ├── docs/ # Documentation │ ├── guides/ # In-depth guides │ ├── references/ # Quick references │ └── practices/ # Best practices ├── rules/ # Rule definitions │ ├── commit/ # Commit-related rules │ ├── quality/ # Code quality rules │ ├── testing/ # Testing rules │ └── verification/ # Verification rules └── hooks/ # Git hooks and scripts ``` #### Key Changes 1. **Logical Categorization**: Organized files into clear categories based on purpose 2. **Improved Documentation**: Added comprehensive README files for each directory 3. **Standardized Naming**: Implemented consistent kebab-case naming convention 4. **Reference Updates**: Updated all internal references to point to new file locations ### Benefits - **Easier Navigation**: Clear categorization makes finding files intuitive - **Improved Understanding**: Comprehensive documentation explains purpose and usage - **Simplified Maintenance**: Logical structure makes updates and additions easier - **Better Onboarding**: New team members can quickly understand the system This refactoring sets a solid foundation for all Cursor AI-related configurations and rules, making it easier for the team to leverage Cursor's capabilities.
61 lines
2.0 KiB
Markdown
61 lines
2.0 KiB
Markdown
# Appsmith Cursor Configuration
|
|
|
|
This directory contains configuration for Cursor AI tools, rules, and guidelines for the Appsmith project.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
.cursor/
|
|
├── settings.json # Main configuration file
|
|
├── docs/ # Documentation
|
|
│ ├── guides/ # In-depth guides
|
|
│ ├── references/ # Quick references
|
|
│ └── practices/ # Best practices
|
|
├── rules/ # Rule definitions
|
|
│ ├── commit/ # Commit-related rules
|
|
│ ├── quality/ # Code quality rules
|
|
│ ├── testing/ # Testing rules
|
|
│ └── verification/ # Verification rules
|
|
└── hooks/ # Git hooks and scripts
|
|
```
|
|
|
|
## Key Features
|
|
|
|
- **Commit Message Rules**: Guidelines for structured, informative commit messages
|
|
- **Code Quality Checks**: Automated validation of code quality standards
|
|
- **Testing Requirements**: Rules for test coverage and quality
|
|
- **Performance Guidelines**: Best practices for maintaining high performance
|
|
- **Documentation**: Comprehensive guides and references for the codebase
|
|
|
|
## Usage
|
|
|
|
- Use the rules in this directory to ensure consistent quality across the project
|
|
- Reference the documentation for best practices and technical details
|
|
- Hooks automate common tasks and enforce quality standards
|
|
|
|
For more information, see the specific README files in each subdirectory.
|
|
|
|
## Commit Message Rules
|
|
|
|
- Messages must be concise and single-line
|
|
- Must start with a verb (e.g., adds, removes, updates)
|
|
- For significant changes:
|
|
|
|
```
|
|
Heading
|
|
|
|
Detailed description
|
|
```
|
|
|
|
## Workspace Rules
|
|
|
|
### Derived Files
|
|
|
|
- Use `/*** */` for comments instead of `//`
|
|
|
|
### Cypress Tests
|
|
|
|
- Run command: `yarn cypress run --browser chrome --headless --spec {fileName}`
|
|
- Execute from: `app/client` directory
|
|
- File paths should be relative to `app/client`
|