Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
19605a6361
PromucFlow_constructor/.cursor/rules
History
vivek-appsmith d176e40726
refactor: restructure .cursor directory for improved organization and clarity (#40196) 
# 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.
2025-04-11 12:04:33 +05:30
..
commit
quality
testing
verification
index.md
index.mdc
README.md

README.md

Appsmith Cursor Rules

This directory contains the rules that Cursor AI uses to validate and improve code quality in the Appsmith project.

Rule Categories

  • commit/: Rules for validating commit messages and pull requests

    • semantic-pr.md: Guidelines for semantic pull request titles

  • quality/: Rules for ensuring code quality

    • performance.mdc: Rules for optimizing performance
    • pre-commit-checks.mdc: Quality checks that run before commits

  • testing/: Rules for test coverage and quality

    • test-generator.mdc: Automated test generation based on code changes

  • verification/: Rules for verifying changes and implementations

    • bug-fix-verifier.mdc: Validation for bug fix implementations
    • feature-verifier.mdc: Validation for feature implementations
    • workflow-validator.mdc: Validation for development workflows

How Rules Work

Each rule is defined in a Markdown Cursor (.mdc) file that includes:

  1. Metadata: Name, description, and trigger conditions
  2. Logic: JavaScript code that implements the rule
  3. Documentation: Usage examples and explanations

Rules are automatically triggered based on events like:

  • Creating or updating pull requests
  • Modifying files
  • Running specific commands in Cursor

Using Rules

You can manually trigger rules using Cursor commands, such as:

  • validate_pr_title: Check if a PR title follows conventions
  • verify_bug_fix: Validate a bug fix implementation
  • generate_tests: Generate tests for changed code
  • optimize_performance: Analyze code for performance issues

Refer to each rule's documentation for specific usage information.