## Description
- Introduced task-list.mdc for guidelines on creating and managing task
lists in Markdown format, detailing structure and maintenance practices.
- Added TASKS.md to .gitignore to prevent tracking of project-specific
task files.
Fixes #`Issue Number`
_or_
Fixes `Issue URL`
> [!WARNING]
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._
## Automation
/ok-to-test tags=""
### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results -->
> [!CAUTION]
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.
<!-- end of auto-generated comment: Cypress test results -->
## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Introduced a new guideline document outlining best practices for
creating and maintaining task lists in Markdown files, including
structure, maintenance, and AI usage instructions.
- **Chores**
- Updated the `.gitignore` file to exclude `TASKS.md` from version
control, ensuring project-specific task files are not tracked.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
|
||
|---|---|---|
| .. | ||
| commit | ||
| quality | ||
| testing | ||
| verification | ||
| index.md | ||
| index.mdc | ||
| README.md | ||
| task-list.mdc | ||
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 performancepre-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 implementationsfeature-verifier.mdc: Validation for feature implementationsworkflow-validator.mdc: Validation for development workflows
How Rules Work
Each rule is defined in a Markdown Cursor (.mdc) file that includes:
- Metadata: Name, description, and trigger conditions
- Logic: JavaScript code that implements the rule
- 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 conventionsverify_bug_fix: Validate a bug fix implementationgenerate_tests: Generate tests for changed codeoptimize_performance: Analyze code for performance issues
Refer to each rule's documentation for specific usage information.