-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Feature/devops admin rules #112
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
base: main
Are you sure you want to change the base?
Conversation
…a Cursor rule that integrates DevSecOps, Secure Software Development Lifecycle (SSDLC), and Application Security (AppSec) best practices. This rule is intended for use in a .cursor/rules/security-devsecops-ssdls-appsec.mdc file and can be adapted to your project’s needs.
WalkthroughThis update introduces a comprehensive set of best practice rules and documentation for DevOps, SRE, system, network, database, VMware, and scripting domains. It adds new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CursorAI
participant RuleLoader
participant RuleFile
User->>CursorAI: Opens file or context (e.g., DB, DevOps, Script)
CursorAI->>RuleLoader: Detect context (e.g., MySQL, Bash, DevOps)
RuleLoader->>RuleFile: Load relevant .cursorrules/.mdc files
RuleFile-->>RuleLoader: Provide best practice rules/guidelines
RuleLoader-->>CursorAI: Inject rules into context
CursorAI-->>User: Apply rules for suggestions, validation, or guidance
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
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: 21
🔭 Outside diff range comments (1)
rules/devops/devops-engineer-enhanced.cursorrules (1)
1-256
: File naming doesn't follow the specified patternAccording to the coding guidelines, .cursorrules files should follow the naming pattern:
technology-focus-cursorrules-prompt-file
. The current filenamedevops-engineer-enhanced.cursorrules
should be renamed to follow this convention, for example:devops-engineering-enhanced-cursorrules-prompt-file
.
🧹 Nitpick comments (16)
rules/admin/network/README.md (1)
32-38
: Tone nitpick – drop “Feel free to”“Feel free to contribute …” is conversational. Replace with a concise imperative: “Contribute by:” to keep docs consistent with the rest of the repo.
-Feel free to contribute to these rules by: +Contribute to these rules by:rules/admin/network/network-engineer.cursorrules (1)
25-31
: Missing inline comments for complex rulesGuidelines: “Include comments in .cursorrules files to explain complex rules or provide context.”
Add short//
comments where interpretation is non-obvious (e.g., QoS, VPN).rules/scripts/posix/bash-script.cursorrules (2)
18-31
: Over-use of “proper” – convert to actionable phrasingExample:
“Use proper file permissions” → “Restrict script files to 750 or stricter.”
“Use set -e …” already concrete – keep.
Refactor remaining bullets for clarity.
68-73
: Add reference comment for log rotation exampleProvide a code snippet (
logrotate.d
sample) so consumers know the expected format.rules/admin/system/README.md (1)
32-38
: Tone nitpick – remove “Feel free to”Mirror wording change proposed for the network README to keep docs consistent.
-Feel free to contribute to these rules by: +Contribute to these rules by:rules/admin/vmware/vmware-admin.cursorrules (1)
4-72
: Reduce repetition and add version-specific context.Many sections duplicate identical bullets (e.g., “Use proper resource allocation”, “Implement proper monitoring”). Consolidate or cross-reference to avoid bloat, and include vSphere / ESXi version notes where recommendations differ (e.g., vSphere 8 DRS vs older releases).
rules/admin/database/README.md (1)
36-42
: Replace informal “Feel free to” phrasing with concise contribution guidance.The repo maintains a professional tone; consider:
-Feel free to contribute to these rules by: +Contributions are welcome. You can:rules/admin/database/redis-dba.cursorrules (1)
12-17
: Double-check persistence advice.Lines 12-17 list both “Set up proper persistence” and “Implement proper caching”. Persistence strategy (RDB/AOF) and caching guidance (maxmemory/eviction) are distinct—consider separating into dedicated subsections for clarity.
rules/admin/system/system-engineer.cursorrules (1)
60-66
: Heavy repetition reduces readabilityThe phrase “Use proper … / Implement proper …” appears 50 + times. Consider grouping generic best-practice verbs in a header comment and omitting them in bullets, OR re-phrasing bullets to start with the noun (“Naming conventions must be consistent with RFC 952”). This will cut noise and emphasise the substance.
rules/admin/vmware/README.md (1)
33-39
: Minor tone / wording improvementThe phrase “Feel free to contribute” is friendly but informal. Using “Contributions are welcome” is clearer and aligns with the more neutral style elsewhere in the repo.
rules/scripts/posix/zsh-script.cursorrules (1)
4-79
: Add concrete examplesE.g. under Security instead of “Use proper quoting”, state
Always wrap variable expansions in double-quotes: "$var"
with an inline comment explaining word-splitting hazards.rules/scripts/powershell/powershell-script.cursorrules (1)
5-80
: Great coverage, but tighten languageMany bullets are already specific (e.g. “Use Pester for testing”)—nice work. A second editing pass to remove remaining generic “proper” fillers will make the file sharper and easier for users to scan.
README.md (2)
32-32
: Remove trailing punctuation from headingThe heading "Key Benefits:" has trailing punctuation which violates markdown best practices (MD026).
-### Key Benefits: +### Key Benefits
295-295
: Remove trailing punctuation from headingThe heading "Contribution Guidelines:" has trailing punctuation which violates markdown best practices (MD026).
-### Contribution Guidelines: +### Contribution Guidelinesrules/security-devsecops-ssdls-appsec.mdc (1)
49-49
: Add newline at end of fileFiles should end with a newline character for better compatibility with various tools and version control systems.
- Document all security controls and decisions for auditability. +- Document all security controls and decisions for auditability. +rules/devops/devops-engineer-enhanced.cursorrules (1)
256-256
: Add newline at end of fileFiles should end with a newline character.
- Documentation of all architectural decisions +- Documentation of all architectural decisions +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (20)
README.md
(4 hunks)rules/admin/database/README.md
(1 hunks)rules/admin/database/mongodb-dba.cursorrules
(1 hunks)rules/admin/database/mysql-dba.cursorrules
(1 hunks)rules/admin/database/postgresql-dba.cursorrules
(1 hunks)rules/admin/database/redis-dba.cursorrules
(1 hunks)rules/admin/network/README.md
(1 hunks)rules/admin/network/network-engineer.cursorrules
(1 hunks)rules/admin/system/README.md
(1 hunks)rules/admin/system/system-engineer.cursorrules
(1 hunks)rules/admin/vmware/README.md
(1 hunks)rules/admin/vmware/vmware-admin.cursorrules
(1 hunks)rules/devops/devops-engineer-enhanced.cursorrules
(1 hunks)rules/devops/devops-engineer.cursorrules
(1 hunks)rules/devops/sre-engineer.cursorrules
(1 hunks)rules/scripts/posix/bash-script.cursorrules
(1 hunks)rules/scripts/posix/zsh-script.cursorrules
(1 hunks)rules/scripts/powercli/powercli-script.cursorrules
(1 hunks)rules/scripts/powershell/powershell-script.cursorrules
(1 hunks)rules/security-devsecops-ssdls-appsec.mdc
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
`rules/**/*`: Regularly review and update categorization as the repository grows.
rules/**/*
: Regularly review and update categorization as the repository grows.
📄 Source: CodeRabbit Inference Engine (.cursorrules)
List of files the instruction was applied to:
rules/admin/system/README.md
rules/admin/network/README.md
rules/admin/database/postgresql-dba.cursorrules
rules/scripts/powercli/powercli-script.cursorrules
rules/admin/database/redis-dba.cursorrules
rules/admin/vmware/README.md
rules/admin/database/README.md
rules/admin/database/mongodb-dba.cursorrules
rules/admin/system/system-engineer.cursorrules
rules/admin/network/network-engineer.cursorrules
rules/admin/database/mysql-dba.cursorrules
rules/devops/devops-engineer.cursorrules
rules/admin/vmware/vmware-admin.cursorrules
rules/scripts/powershell/powershell-script.cursorrules
rules/scripts/posix/zsh-script.cursorrules
rules/devops/sre-engineer.cursorrules
rules/scripts/posix/bash-script.cursorrules
rules/security-devsecops-ssdls-appsec.mdc
rules/devops/devops-engineer-enhanced.cursorrules
`**/*`: Maintain consistency in capitalization and punctuation throughout the repository. When referencing Cursor AI, always use the correct capitalization and spacing.
**/*
: Maintain consistency in capitalization and punctuation throughout the repository.
When referencing Cursor AI, always use the correct capitalization and spacing.
📄 Source: CodeRabbit Inference Engine (.cursorrules)
List of files the instruction was applied to:
rules/admin/system/README.md
rules/admin/network/README.md
rules/admin/database/postgresql-dba.cursorrules
rules/scripts/powercli/powercli-script.cursorrules
rules/admin/database/redis-dba.cursorrules
rules/admin/vmware/README.md
rules/admin/database/README.md
rules/admin/database/mongodb-dba.cursorrules
rules/admin/system/system-engineer.cursorrules
rules/admin/network/network-engineer.cursorrules
rules/admin/database/mysql-dba.cursorrules
rules/devops/devops-engineer.cursorrules
rules/admin/vmware/vmware-admin.cursorrules
rules/scripts/powershell/powershell-script.cursorrules
rules/scripts/posix/zsh-script.cursorrules
rules/devops/sre-engineer.cursorrules
rules/scripts/posix/bash-script.cursorrules
rules/security-devsecops-ssdls-appsec.mdc
README.md
rules/devops/devops-engineer-enhanced.cursorrules
`rules/**/*.cursorrules`: Organize .cursorrules files into the following main ca...
rules/**/*.cursorrules
: Organize .cursorrules files into the following main categories within the 'rules' directory: Frontend Frameworks and Libraries, Backend and Full-Stack, Mobile Development, CSS and Styling, State Management, Database and API, Testing, Build Tools and Development, Language-Specific, Other.
Place each .cursorrules file directly in the 'rules' folder.
Use descriptive names for .cursorrules files and their folders, following the pattern: 'technology-focus-cursorrules-prompt-file'.
When creating or editing .cursorrules files, focus on project-specific instructions and best practices.
Include comments in .cursorrules files to explain complex rules or provide context.
Use clear and concise language in all .cursorrules files.
Provide context on what you're building, style guidelines, or info on commonly-used methods.
If a .cursorrules file fits multiple categories, place it in the most relevant one and cross-reference in others if necessary.
📄 Source: CodeRabbit Inference Engine (.cursorrules)
List of files the instruction was applied to:
rules/admin/database/postgresql-dba.cursorrules
rules/scripts/powercli/powercli-script.cursorrules
rules/admin/database/redis-dba.cursorrules
rules/admin/database/mongodb-dba.cursorrules
rules/admin/system/system-engineer.cursorrules
rules/admin/network/network-engineer.cursorrules
rules/admin/database/mysql-dba.cursorrules
rules/devops/devops-engineer.cursorrules
rules/admin/vmware/vmware-admin.cursorrules
rules/scripts/powershell/powershell-script.cursorrules
rules/scripts/posix/zsh-script.cursorrules
rules/devops/sre-engineer.cursorrules
rules/scripts/posix/bash-script.cursorrules
rules/devops/devops-engineer-enhanced.cursorrules
`README.md`: Always use Markdown for documentation and README files. Maintain th...
README.md
: Always use Markdown for documentation and README files.
Maintain the existing structure of the README.md file.
Maintain the following structure in the README.md file: 1. Title and Awesome badge 2. Logo 3. Short description 4. "Why .cursorrules?" section 5. Table of Contents 6. Rules section (with specified subcategories) 7. How to Use section 8. Contributing section 9. License section.
Maintain alphabetical order within each category in the README.md file.
Use consistent formatting for list items in the README.md file.
Update the README.md file when adding new .cursorrules files, placing them in the correct category.
Ensure all links in the README.md file are relative and correct.
When updating the README.md, ensure the table of contents remains accurate.
When adding new categories, update both the 'Contents' and 'Rules' sections of the README.md.
📄 Source: CodeRabbit Inference Engine (.cursorrules)
List of files the instruction was applied to:
README.md
🪛 LanguageTool
rules/admin/system/README.md
[style] ~33-~33: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...inistration standards ## Contributing Feel free to contribute to these rules by: 1. Adding...
(FEEL_FREE_TO_STYLE_ME)
rules/admin/network/README.md
[style] ~33-~33: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...andards and protocols ## Contributing Feel free to contribute to these rules by: 1. Adding...
(FEEL_FREE_TO_STYLE_ME)
rules/admin/vmware/README.md
[style] ~34-~34: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...VMware best practices ## Contributing Feel free to contribute to these rules by: 1. Adding...
(FEEL_FREE_TO_STYLE_ME)
rules/admin/database/README.md
[style] ~37-~37: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ng database standards ## Contributing Feel free to contribute to these rules by: 1. Adding...
(FEEL_FREE_TO_STYLE_ME)
README.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...across your team - 🚀 Productivity: Speed up development with AI-powered assistance ...
(SPEED_UP_ACCELERATE)
[duplication] ~223-~223: Possible typo: you repeated a word.
Context: ...s) ### DevOps and Administration #### DevOps - [DevOps Engineer](./rules/devops/devops-enginee...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~269-~269: The inflection of the verb “Browse” seems to be incorrect here.
Context: ...//cursor.sh/) if you haven't already 2. Browse the rules above to find a `.cursorrules...
(PRP_HAVE_VB)
🪛 markdownlint-cli2 (0.17.2)
README.md
32-32: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
58-58: Link fragments should be valid
null
(MD051, link-fragments)
295-295: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (3)
rules/admin/database/mysql-dba.cursorrules (1)
4-17
: Clarify performance-tuning recommendations.“Implement proper query cache” is obsolete from MySQL 8 onward (query cache was removed). Specify version or suggest alternative (e.g., InnoDB buffer pool sizing,
performance_schema
insights).rules/admin/vmware/README.md (1)
1-32
: README looks goodContent is clear, capitalization of “Cursor AI” is consistent, and sections mirror other admin READMEs.
README.md (1)
224-226
: Update file references after renaming .cursorrules filesOnce the .cursorrules files are renamed to follow the
technology-focus-cursorrules-prompt-file
pattern, these references in the README will need to be updated accordingly. For example:
devops-engineer.cursorrules
→devops-engineering-cursorrules-prompt-file
sre-engineer.cursorrules
→sre-engineering-cursorrules-prompt-file
This applies to all .cursorrules file references in this section.
Also applies to: 228-232, 234-237, 240-242
- `network-engineer.cursorrules` - Rules for network engineering tasks and best practices | ||
|
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.
Path & categorisation violate repository rules directory policy
Per the project-level “.cursorrules
must live directly under rules/
and be grouped into the predefined top-level categories (Database and API, …)” guideline, referencing the file here (network-engineer.cursorrules
) from a nested rules/admin/network/
folder does not comply.
Move the rule file to rules/database-and-api/
(or a category you deem more appropriate) and leave a short README.md
or an index link instead.
🤖 Prompt for AI Agents
In rules/admin/network/README.md around lines 7 to 8, the reference to
`network-engineer.cursorrules` violates the repository directory policy because
`.cursorrules` files must be placed directly under the top-level rules/ folder
within predefined categories like database-and-api. Move the
`network-engineer.cursorrules` file from the nested rules/admin/network/
directory to an appropriate top-level category folder such as
rules/database-and-api/, then replace the original reference with a short README
or an index link pointing to the new location.
// Network Engineering Best Practices | ||
// This file contains rules and guidelines for Network Engineering | ||
|
||
// Network Design |
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.
File placement & naming break catalog conventions
The file resides in rules/admin/network/
and is named network-engineer.cursorrules
.
Guidelines require:
- Location: directly under
rules/
. - Name format:
<technology>-<focus>-cursorrules-prompt-file
.
Please relocate (e.g., rules/network-engineering-cursorrules-prompt-file
) or decide on the “Database and API” vs “Other” bucket.
🤖 Prompt for AI Agents
In rules/admin/network/network-engineer.cursorrules lines 1 to 4, the file is
incorrectly placed under rules/admin/network/ and named
network-engineer.cursorrules, which breaks catalog conventions. Move the file
directly under the rules/ directory and rename it following the format
<technology>-<focus>-cursorrules-prompt-file, for example,
rules/network-engineering-cursorrules-prompt-file. Confirm whether it belongs to
the "Database and API" or "Other" category to finalize its placement.
// Network Design | ||
- Use proper network architecture | ||
- Implement proper network segmentation | ||
- Use proper network redundancy | ||
- Implement proper network security | ||
- Use proper network documentation | ||
|
||
// Security | ||
- Use proper access control | ||
- Implement proper firewall rules | ||
- Use proper encryption | ||
- Implement proper VPN configuration | ||
- Use proper security policies | ||
|
||
// Performance | ||
- Use proper bandwidth management | ||
- Implement proper QoS policies | ||
- Use proper traffic shaping | ||
- Implement proper load balancing | ||
- Use proper performance monitoring | ||
|
||
// Documentation | ||
- Document all network configurations | ||
- Document all network changes | ||
- Document all network policies | ||
- Document all network incidents | ||
- Document all network procedures | ||
|
||
// Monitoring | ||
- Use proper network monitoring | ||
- Implement proper alerting | ||
- Use proper logging | ||
- Implement proper reporting | ||
- Use proper analysis | ||
|
||
// Troubleshooting | ||
- Use proper diagnostic tools | ||
- Implement proper troubleshooting procedures | ||
- Use proper network analysis | ||
- Implement proper problem resolution | ||
- Use proper documentation | ||
|
||
// Configuration Management | ||
- Use proper version control | ||
- Implement proper change management | ||
- Use proper configuration backup | ||
- Implement proper configuration testing | ||
- Use proper configuration documentation | ||
|
||
// Network Services | ||
- Use proper DNS configuration | ||
- Implement proper DHCP configuration | ||
- Use proper routing configuration | ||
- Implement proper switching configuration | ||
- Use proper service documentation | ||
|
||
// Best Practices | ||
- Use proper naming conventions | ||
- Implement proper procedures | ||
- Use proper documentation | ||
- Implement proper training | ||
- Use proper communication | ||
|
||
// Disaster Recovery | ||
- Implement proper backup procedures | ||
- Use proper recovery procedures | ||
- Implement proper failover procedures | ||
- Use proper disaster recovery testing | ||
- Implement proper documentation |
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.
🛠️ Refactor suggestion
Content is too generic & repetitive – provide concrete, actionable rules
Every bullet starts with “Use/Implement proper …”. This reduces signal-to-noise, and does not satisfy “clear and concise language”/“project-specific instructions” requirements.
Provide explicit guidance (e.g., “Implement BGP-based ECMP for WAN redundancy” instead of “Use proper network redundancy”).
🤖 Prompt for AI Agents
In rules/admin/network/network-engineer.cursorrules from lines 4 to 72, the
content is overly generic and repetitive, with each bullet starting with
"Use/Implement proper ...". Replace these vague statements with specific,
actionable rules that provide clear technical guidance, such as naming exact
protocols, configurations, or procedures (e.g., "Implement BGP-based ECMP for
WAN redundancy" instead of "Use proper network redundancy"). Ensure each rule is
concise, project-specific, and directly instructive to improve clarity and
usefulness.
// POSIX Bash Script Best Practices | ||
// This file contains rules and guidelines for POSIX bash scripting | ||
|
||
// Script Structure |
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.
Relocate & rename to satisfy top-level scripting category
Move file to rules/language-specific/bash-script-cursorrules-prompt-file
(or “Other”) to obey directory conventions.
🤖 Prompt for AI Agents
In rules/scripts/posix/bash-script.cursorrules lines 1 to 4, the file location
and name do not follow the directory conventions. Move the file to the path
rules/language-specific/bash-script-cursorrules-prompt-file or alternatively to
the "Other" category folder to comply with the top-level scripting category
structure.
- `system-engineer.cursorrules` - Rules for system engineering tasks and best practices | ||
|
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.
Incorrect reference path to rule file
Same placement issue: system-engineer.cursorrules
should live under rules/
, not the nested folder, otherwise Cursor AI autoloader may not discover it.
🤖 Prompt for AI Agents
In rules/admin/system/README.md around lines 7 to 8, the reference to
`system-engineer.cursorrules` is incorrect because it points to a nested folder.
Move the `system-engineer.cursorrules` file directly under the `rules/`
directory instead of the nested folder to ensure the Cursor AI autoloader can
discover it properly.
// POSIX Zsh Script Best Practices | ||
// This file contains rules and guidelines for POSIX zsh scripting | ||
|
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.
🛠️ Refactor suggestion
Relocate & rename to satisfy repo rules
Move to rules/zsh-scripting-cursorrules.prompt
(or similar) per guidelines.
🤖 Prompt for AI Agents
In rules/scripts/posix/zsh-script.cursorrules at lines 1 to 3, the file location
and name do not comply with repository naming conventions. Move the file to the
rules directory and rename it to zsh-scripting-cursorrules.prompt or a similar
name that fits the repo guidelines.
// PowerShell Script Best Practices | ||
|
||
// This file contains rules and guidelines for PowerShell scripting | ||
|
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.
🛠️ Refactor suggestion
Relocate & rename for consistency
Should reside directly under rules/
and match naming scheme, e.g. powershell-scripting-cursorrules.prompt
.
🤖 Prompt for AI Agents
In rules/scripts/powershell/powershell-script.cursorrules at lines 1 to 4, the
file is misplaced and misnamed. Move the file directly under the rules/
directory and rename it to follow the naming convention, such as
powershell-scripting-cursorrules.prompt, to ensure consistency with other rule
files.
// Site Reliability Engineering (SRE) Best Practices | ||
// This file contains rules and guidelines for SRE tasks | ||
|
||
// Service Level Objectives (SLOs) | ||
- Define clear service level objectives | ||
- Implement proper error budgets | ||
- Monitor SLO compliance | ||
- Set up proper alerting thresholds | ||
- Document SLO targets and measurements | ||
|
||
// Monitoring and Observability | ||
- Implement comprehensive monitoring | ||
- Use proper metrics collection | ||
- Set up proper logging | ||
- Implement proper tracing | ||
- Use proper dashboards | ||
|
||
// Incident Management | ||
- Implement proper incident response | ||
- Use proper incident documentation | ||
- Set up proper on-call rotations | ||
- Implement proper post-mortems | ||
- Use proper incident tracking | ||
|
||
// Capacity Planning | ||
- Implement proper capacity forecasting | ||
- Use proper resource scaling | ||
- Set up proper load testing | ||
- Implement proper performance testing | ||
- Use proper capacity documentation | ||
|
||
// Automation | ||
- Automate repetitive tasks | ||
- Implement proper deployment automation | ||
- Use proper configuration management | ||
- Implement proper testing automation | ||
- Use proper monitoring automation | ||
|
||
// Reliability | ||
- Implement proper redundancy | ||
- Use proper failover mechanisms | ||
- Set up proper disaster recovery | ||
- Implement proper backup strategies | ||
- Use proper reliability testing | ||
|
||
// Performance | ||
- Implement proper performance monitoring | ||
- Use proper performance optimization | ||
- Set up proper load balancing | ||
- Implement proper caching strategies | ||
- Use proper performance documentation | ||
|
||
// Security | ||
- Implement proper security monitoring | ||
- Use proper access control | ||
- Set up proper security scanning | ||
- Implement proper security testing | ||
- Use proper security documentation | ||
|
||
// Documentation | ||
- Document all procedures | ||
- Document all configurations | ||
- Document all incidents | ||
- Document all changes | ||
- Document all best practices | ||
|
||
// Best Practices | ||
- Use proper naming conventions | ||
- Implement proper procedures | ||
- Use proper documentation | ||
- Implement proper training | ||
- Use proper communication |
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.
🛠️ Refactor suggestion
File naming doesn't follow the specified pattern
According to the coding guidelines, .cursorrules files should follow the naming pattern: technology-focus-cursorrules-prompt-file
. The current filename sre-engineer.cursorrules
should be renamed to follow this convention, for example: sre-engineering-cursorrules-prompt-file
.
🤖 Prompt for AI Agents
In rules/devops/sre-engineer.cursorrules lines 1 to 72, the filename does not
follow the required naming pattern. Rename the file to match the pattern
technology-focus-cursorrules-prompt-file, for example, change it to
sre-engineering-cursorrules-prompt-file to comply with the coding guidelines.
// DevOps Engineer Best Practices | ||
// This file contains rules and guidelines for DevOps engineering tasks | ||
|
||
// Infrastructure as Code (IaC) | ||
- Use declarative configuration management tools (Terraform, Ansible, etc.) | ||
- Version control all infrastructure code | ||
- Implement infrastructure testing | ||
- Use modules and reusable components | ||
- Document infrastructure architecture | ||
|
||
// CI/CD Pipeline | ||
- Implement automated testing in pipelines | ||
- Use version control for pipeline configurations | ||
- Implement security scanning in CI/CD | ||
- Use environment-specific configurations | ||
- Implement rollback procedures | ||
|
||
// Monitoring and Logging | ||
- Implement centralized logging | ||
- Set up monitoring and alerting | ||
- Use metrics for performance tracking | ||
- Implement log rotation and retention policies | ||
- Set up dashboards for key metrics | ||
|
||
// Security | ||
- Implement least privilege access | ||
- Use secrets management | ||
- Regular security audits | ||
- Implement network security policies | ||
- Use secure communication protocols | ||
|
||
// Containerization | ||
- Use multi-stage builds | ||
- Implement container security scanning | ||
- Use container orchestration | ||
- Implement resource limits | ||
- Use container health checks | ||
|
||
// Cloud Services | ||
- Use cloud-native services when appropriate | ||
- Implement cost optimization | ||
- Use region-specific configurations | ||
- Implement disaster recovery | ||
- Use cloud security best practices | ||
|
||
// Automation | ||
- Automate repetitive tasks | ||
- Use configuration management | ||
- Implement self-healing systems | ||
- Use automated testing | ||
- Implement automated deployment | ||
|
||
// Documentation | ||
- Document all infrastructure changes | ||
- Maintain runbooks | ||
- Document disaster recovery procedures | ||
- Keep architecture diagrams updated | ||
- Document security procedures | ||
|
||
// Collaboration | ||
- Use version control for all code | ||
- Implement code review processes | ||
- Use issue tracking | ||
- Maintain documentation | ||
- Regular team communication | ||
|
||
// Performance | ||
- Implement performance monitoring | ||
- Use caching strategies | ||
- Optimize resource usage | ||
- Implement load balancing | ||
- Regular performance testing | ||
|
||
// Disaster Recovery | ||
- Implement backup strategies | ||
- Document recovery procedures | ||
- Regular disaster recovery testing | ||
- Implement failover procedures | ||
- Maintain recovery documentation |
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.
🛠️ Refactor suggestion
File naming doesn't follow the specified pattern
According to the coding guidelines, .cursorrules files should follow the naming pattern: technology-focus-cursorrules-prompt-file
. The current filename devops-engineer.cursorrules
should be renamed to follow this convention, for example: devops-engineering-cursorrules-prompt-file
.
🤖 Prompt for AI Agents
In rules/devops/devops-engineer.cursorrules lines 1 to 79, the filename does not
follow the required naming pattern for .cursorrules files. Rename the file to
match the pattern technology-focus-cursorrules-prompt-file, such as
devops-engineering-cursorrules-prompt-file, to comply with the coding
guidelines.
description: Enforce DevSecOps, SSDLC, and AppSec best practices for all code generated in this project. | ||
globs: ["**/*.py", "**/*.js", "**/*.ts", "**/*.go", "**/*.java", "**/*.rb", "**/*.php", "**/*.cs", "**/*.sh"] | ||
alwaysApply: true | ||
write by Haim Cohen [https://www.linkedin.com/in/haimc/] |
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.
Fix invalid YAML syntax
The metadata on line 5 is not valid YAML syntax. It should be formatted as a proper key-value pair.
-write by Haim Cohen [https://www.linkedin.com/in/haimc/]
+author: Haim Cohen
+authorUrl: https://www.linkedin.com/in/haimc/
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
write by Haim Cohen [https://www.linkedin.com/in/haimc/] | |
author: Haim Cohen | |
authorUrl: https://www.linkedin.com/in/haimc/ |
🤖 Prompt for AI Agents
In rules/security-devsecops-ssdls-appsec.mdc at line 5, the metadata "write by
Haim Cohen [https://www.linkedin.com/in/haimc/]" is not valid YAML syntax.
Change it to a proper key-value pair format, for example, use a key like
"author" followed by a colon and the value as a string including the name and
URL, ensuring it conforms to YAML syntax rules.
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: 1
🧹 Nitpick comments (3)
README.md (3)
32-33
: Drop the trailing colon in the “Key Benefits” heading
markdownlint
(MD026) flags punctuation at the end of headings.-### Key Benefits: +### Key Benefits
296-297
: Drop the trailing colon in “Contribution Guidelines”Same MD026 warning as above.
-### Contribution Guidelines: +### Contribution Guidelines
270-272
: Small wording tweak for clarity/grammar“Browse” in imperative form reads a bit awkwardly in this numbered list. Consider:
-2. Browse the rules above to find a `.cursorrules` file that suits your needs +2. Review the rules above to find a `.cursorrules` file that suits your needs
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md
(4 hunks)rules/devops/devops-engineer-enhanced.cursorrules
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- rules/devops/devops-engineer-enhanced.cursorrules
🧰 Additional context used
📓 Path-based instructions (2)
`README.md`: Always use Markdown for documentation and README files. Maintain th...
README.md
: Always use Markdown for documentation and README files.
Maintain the existing structure of the README.md file.
Maintain the following structure in the README.md file: 1. Title and Awesome badge 2. Logo 3. Short description 4. "Why .cursorrules?" section 5. Table of Contents 6. Rules section (with specified subcategories) 7. How to Use section 8. Contributing section 9. License section.
Maintain alphabetical order within each category in the README.md file.
Use consistent formatting for list items in the README.md file.
Update the README.md file when adding new .cursorrules files, placing them in the correct category.
Ensure all links in the README.md file are relative and correct.
When updating the README.md, ensure the table of contents remains accurate.
When adding new categories, update both the 'Contents' and 'Rules' sections of the README.md.
📄 Source: CodeRabbit Inference Engine (.cursorrules)
List of files the instruction was applied to:
README.md
`**/*`: Maintain consistency in capitalization and punctuation throughout the repository. When referencing Cursor AI, always use the correct capitalization and spacing.
**/*
: Maintain consistency in capitalization and punctuation throughout the repository.
When referencing Cursor AI, always use the correct capitalization and spacing.
📄 Source: CodeRabbit Inference Engine (.cursorrules)
List of files the instruction was applied to:
README.md
🪛 LanguageTool
README.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...across your team - 🚀 Productivity: Speed up development with AI-powered assistance ...
(SPEED_UP_ACCELERATE)
[duplication] ~223-~223: Possible typo: you repeated a word.
Context: ...s) ### DevOps and Administration #### DevOps - [DevOps Engineer](./rules/devops/devops-enginee...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~270-~270: The inflection of the verb “Browse” seems to be incorrect here.
Context: ...//cursor.sh/) if you haven't already 2. Browse the rules above to find a `.cursorrules...
(PRP_HAVE_VB)
🪛 markdownlint-cli2 (0.17.2)
README.md
32-32: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
58-58: Link fragments should be valid
null
(MD051, link-fragments)
296-296: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (1)
README.md (1)
58-60
: Verify “Directories” link fragmentStatic analysis (
MD051
) reports an invalid fragment for[Directories](#directories)
.
GitHub sometimes prefixes an extra hyphen when the heading contains an emoji (## 📚 Directories
).
Please double-check the rendered anchor and adjust either the heading or the link so they match.
#### Database Administration | ||
- [PostgreSQL DBA](./rules/admin/database/postgresql-dba.cursorrules) - Best practices for PostgreSQL database administration | ||
- [MySQL DBA](./rules/admin/database/mysql-dba.cursorrules) - Best practices for MySQL database administration | ||
- [MongoDB DBA](./rules/admin/database/mongodb-dba.cursorrules) - Best practices for MongoDB database administration | ||
- [Redis DBA](./rules/admin/database/redis-dba.cursorrules) - Best practices for Redis database administration | ||
|
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.
🛠️ Refactor suggestion
Alphabetize the Database Administration list
The current order is not alphabetical (PostgreSQL
, MySQL
, MongoDB
, Redis
).
Re-ordering improves scan-ability and keeps the file consistent with the project’s alphabetical-ordering guideline.
-#### Database Administration
-- [PostgreSQL DBA](./rules/admin/database/postgresql-dba.cursorrules) - Best practices for PostgreSQL database administration
-- [MySQL DBA](./rules/admin/database/mysql-dba.cursorrules) - Best practices for MySQL database administration
-- [MongoDB DBA](./rules/admin/database/mongodb-dba.cursorrules) - Best practices for MongoDB database administration
-- [Redis DBA](./rules/admin/database/redis-dba.cursorrules) - Best practices for Redis database administration
+#### Database Administration
+- [MongoDB DBA](./rules/admin/database/mongodb-dba.cursorrules) - Best practices for MongoDB database administration
+- [MySQL DBA](./rules/admin/database/mysql-dba.cursorrules) - Best practices for MySQL database administration
+- [PostgreSQL DBA](./rules/admin/database/postgresql-dba.cursorrules) - Best practices for PostgreSQL database administration
+- [Redis DBA](./rules/admin/database/redis-dba.cursorrules) - Best practices for Redis database administration
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
#### Database Administration | |
- [PostgreSQL DBA](./rules/admin/database/postgresql-dba.cursorrules) - Best practices for PostgreSQL database administration | |
- [MySQL DBA](./rules/admin/database/mysql-dba.cursorrules) - Best practices for MySQL database administration | |
- [MongoDB DBA](./rules/admin/database/mongodb-dba.cursorrules) - Best practices for MongoDB database administration | |
- [Redis DBA](./rules/admin/database/redis-dba.cursorrules) - Best practices for Redis database administration | |
#### Database Administration | |
- [MongoDB DBA](./rules/admin/database/mongodb-dba.cursorrules) - Best practices for MongoDB database administration | |
- [MySQL DBA](./rules/admin/database/mysql-dba.cursorrules) - Best practices for MySQL database administration | |
- [PostgreSQL DBA](./rules/admin/database/postgresql-dba.cursorrules) - Best practices for PostgreSQL database administration | |
- [Redis DBA](./rules/admin/database/redis-dba.cursorrules) - Best practices for Redis database administration |
🤖 Prompt for AI Agents
In README.md around lines 228 to 233, the list under "Database Administration"
is not in alphabetical order. Reorder the entries so that they appear
alphabetically by database name: MySQL, MongoDB, PostgreSQL, Redis. This will
improve readability and maintain consistency with the project's alphabetical
ordering guideline.
Summary by CodeRabbit