feat: Add cursor rules and configuration files

[rahulbarwal]

Description

Introduced a new directory for cursor-specific rules and behaviors, including commit message guidelines and workspace rules for derived files and Cypress tests. This enhances the consistency and clarity of our development practices.

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

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• Documentation
  • Expanded project guidelines to clarify best practices for team communications, workspace organization, and testing procedures—enhancing internal coordination and overall product quality.

[coderabbitai]

Walkthrough

Two new files have been added to the .cursor directory. The README.md file documents guidelines for commit message formatting, workspace comment styles, and instructions for executing Cypress tests. The rules.json file defines similar configuration rules programmatically, specifying allowed commit verbs, message structure for big changes, the use of block comments for derived files, and details for running Cypress tests. These additions establish clear standards for contributions and testing practices.

Changes

File(s)	Change Summary
.cursor/README.md, .cursor/rules.json	Added documentation and configuration to enforce commit message rules, workspace comment formatting, and Cypress test execution guidelines.

Possibly related PRs

• fix: cypress command reverted PR #39141: Adjustments in Cypress test execution instructions and derived file rules in that PR relate to the configurations introduced here.

Suggested labels

Task, ok-to-test

Poem

In the realm of cursors, guidelines take flight,
Commit messages and tests shine ever so bright.
JSON and Markdown, side by side they stand,
Clear rules and tips crafted by careful hand.
Here’s to order in code and a journey so neat—
A celebration of clarity in every commit beat!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a07f048 and 36bd2df.

📒 Files selected for processing (2)

• .cursor/README.md (1 hunks)
• .cursor/rules.json (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

.cursor/README.md

11-11: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

🔇 Additional comments (3)

.cursor/README.md (2)

1-28: Overall README Structure Appears Sound
The documentation clearly outlines the commit message rules, workspace guidelines for derived files, and instructions for running Cypress tests. The content is clear, well-organized, and meets the intended configuration objectives.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

11-11: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

11-15: Specify Language for Fenced Code Blocks
The fenced code block on these lines is missing a language specifier, which causes markdownlint warnings (MD040). Specifying the language (for example, txt if it’s plain text) will improve syntax highlighting and clarity. Consider applying the following diff:

-  ```
+  ```txt

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

11-11: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

.cursor/rules.json (1)

1-42: JSON Configuration Appears Comprehensive and Consistent
The new configuration file accurately encapsulates the commit and workspace rules as outlined in the README. The defined keys for commitRules and workspaceRules match the intended guidelines, ensuring consistency between documentation and programmatic configuration.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.