-
Notifications
You must be signed in to change notification settings - Fork 1
feat(rules): add code quality cursor rules #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughA set of new documentation and rule files were added under the Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Repo
participant RulesEngine
Developer->>Repo: Add/commit files and documentation
Repo->>RulesEngine: Apply .cursor/rules/* rules on commit, edit, and review
RulesEngine-->>Developer: Enforce commit message standards, editing practices, info verification, etc.
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
🔍 Vulnerabilities of
|
| digest | sha256:03e1afaf63dbdec8f0d1ee90ffa1977582ce467562192944b35549a143019068 |
| vulnerabilities | |
| platform | linux/amd64 |
| size | 243 MB |
| packages | 1628 |
📦 Base Image node:20-alpine
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 11
🧹 Nitpick comments (8)
.cursor/rules/service-configuration.mdc (5)
1-5: Populate front matter metadata
The YAML front matter has emptydescriptionandglobsfields, which reduces discoverability and may confuse tooling that relies on these values. Consider adding a concise summary underdescriptionand listing any relevant file patterns underglobs(or removing them if not needed).
9-12: Clarify link formatting for the setup script
The link[scripts/setup_volumes.sh](mdc:scripts/setup_volumes.sh)uses a custommdc:scheme. If your renderer doesn’t support it, switch to a standard relative path link (for example,[scripts/setup_volumes.sh](../scripts/setup_volumes.sh)) or document the custom protocol.
14-20: Include sample invocation for health checks
Listing the endpoints is helpful, but users may benefit from seeing how to invoke the verification script. For example, wrapbash scripts/check_services.shin a code block and show a snippet of expected output or typical error messages.
27-27: Specify container/service name for logs
The instructiondocker logsis incomplete—it requires a container name or ID. For Docker Compose environments, considerdocker compose logs -f <service>or explicitlydocker logs <container>to guide the user.
30-31: Reference the setup script explicitly or merge steps
Step 4 (“Run setup script for volume mount issues”) duplicates the earlier setup instructions. Either point directly to./scripts/setup_volumes.shhere or merge this step with the initial “Setup Instructions” to avoid redundancy..cursor/rules/conventional-commits.mdc (3)
6-9: Add direct link to the Conventional Commits spec
Rather than referring generically, embed a hyperlink to the official specification. For example:Use the [Conventional Commits](https://conventionalcommits.org/) specification to generate commit messages.
12-18: Specify language for the code block
The commit message structure is enclosed in triple backticks without a language. For better syntax highlighting, declare it as e.g.<type>[optional scope]: <description> …
22-26: Standardize bullet formatting for commit types
The first three list items include the colon inside backticks (e.g.,`fix`:) while the “Other allowed types” line embeds colons in each type. Align these—for example, remove trailing colons within the code ticks or make all types consistent.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
.cursor/rules/conventional-commits.mdc(1 hunks).cursor/rules/docker-configuration.mdc(1 hunks).cursor/rules/no-apologies-rule.mdc(1 hunks).cursor/rules/no-summaries-rule.mdc(1 hunks).cursor/rules/no-unnecessary-confirmations-rule.mdc(1 hunks).cursor/rules/no-unnecessary-updates-rule.mdc(1 hunks).cursor/rules/preserve-existing-code-rule.mdc(1 hunks).cursor/rules/project-structure.mdc(1 hunks).cursor/rules/service-configuration.mdc(1 hunks).cursor/rules/single-chunk-edits-rule.mdc(1 hunks).cursor/rules/verify-information-rule.mdc(1 hunks).gitignore(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Docker Security Scanning (n8n, Dockerfile.n8n, n8n-test:latest)
- GitHub Check: Service Availability Check
🔇 Additional comments (1)
.gitignore (1)
10-16: Standard IDE and OS artifacts ignored
The added patterns (.idea/,.vscode/,*.swp,*.swo, and.DS_Store) correctly exclude common IDE and temporary files. This aligns with best practices for cross-platform development.
- Add no-apologies rule - Add no-summaries rule - Add no-unnecessary-confirmations rule - Add no-unnecessary-updates rule - Add preserve-existing-code rule - Add single-chunk-edits rule - Add verify-information rule These rules will help maintain consistent and high-quality AI interactions in the project.
- Added a guideline to always verify information before presenting it, emphasizing the importance of clear evidence over speculation.
- Enhanced multiple rules by adding clear descriptions to improve understanding of their purpose. - Updated glob patterns for each rule to specify applicable file types, ensuring better application of the rules across the project.
Update .gitignore to include all subdirectories under .cursor/rules by changing '!.cursor/rules/' to '!.cursor/rules/**'
363a1be to
f937582
Compare
This change sets environment variables for Docker Scout using GitHub Secrets. It ensures authenticated scanning of images for vulnerabilities, improving the reliability of the workflow.
* Update github/codeql-action from v2 to v3 to address deprecation warning * Remove redundant Docker Scout authentication env vars since they're inherited from docker/login-action BREAKING CHANGE: CodeQL Action v2 support will be removed in January 2025
|
🔍 Vulnerabilities of
|
| digest | sha256:5d0968306cfd5c6b1cac8fc4ddaabe692c35b0fd8e81dc8b56a6ab9755dabdc7 |
| vulnerabilities | |
| platform | linux/amd64 |
| size | 243 MB |
| packages | 1628 |
📦 Base Image node:20-alpine
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
|



feat(rules): add code quality cursor rules
Description
This PR adds a set of code quality cursor rules to improve AI interactions and maintain consistency across the project.
Changes
Impact
These rules will help: