## 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 -->
|
||
|---|---|---|
| .. | ||
| docs | ||
| hooks | ||
| rules | ||
| incremental_learning.json | ||
| index.mdc | ||
| README.md | ||
| rules.json | ||
| settings.json | ||
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/clientdirectory - File paths should be relative to
app/client