.cursorrules Code Guidelines

by @Hamza Farhan

1. **Verify Information**: Always verify information before presenting it. Do not make assumptions or speculate without clear evidence.

2. **File-by-File Changes**: Make changes file by file and give me a chance to spot mistakes.

3. **No Apologies**: Never use apologies.

4. **No Understanding Feedback**: Avoid giving feedback about understanding in comments or documentation.

5. **No Whitespace Suggestions**: Don't suggest whitespace changes.

6. **No Summaries**: Don't summarize changes made.

7. **No Inventions**: Don't invent changes other than what's explicitly requested.

8. **No Unnecessary Confirmations**: Don't ask for confirmation of information already provided in the context.

9. **Preserve Existing Code**: Don't remove unrelated code or functionalities. Pay attention to preserving existing structures.

10. **Single Chunk Edits**: Provide all edits in a single chunk instead of multiple-step instructions or explanations for the same file.

11. **No Implementation Checks**: Don't ask the user to verify implementations that are visible in the provided context.

12. **No Unnecessary Updates**: Don't suggest updates or changes to files when there are no actual modifications needed.

13. **Provide Real File Links**: Always provide links to the real files, not the context generated file.

14. **No Current Implementation**: Don't show or discuss the current implementation unless specifically requested.

15. **Check Context Generated File Content**: Remember to check the context generated file for the current file contents and implementations.

16. **Use Explicit Variable Names**: Prefer descriptive, explicit variable names over short, ambiguous ones to enhance code readability.

17. **Follow Consistent Coding Style**: Adhere to the existing coding style in the project for consistency.

18. **Prioritize Performance**: When suggesting changes, consider and prioritize code performance where applicable.

19. **Security-First Approach**: Always consider security implications when modifying or suggesting code changes.

20. **Test Coverage**: Suggest or include appropriate unit tests for new or modified code.

21. **Error Handling**: Implement robust error handling and logging where necessary.

22. **Modular Design**: Encourage modular design principles to improve code maintainability and reusability.

23. **Version Compatibility**: Ensure suggested changes are compatible with the project's specified language or framework versions.

24. **Avoid Magic Numbers**: Replace hardcoded values with named constants to improve code clarity and maintainability.

25. **Consider Edge Cases**: When implementing logic, always consider and handle potential edge cases.

26. **Use Assertions**: Include assertions wherever possible to validate assumptions and catch potential errors early.

Code Analysis Tool

Analyzes code for compliance with .cursorrules AI guidelines, highlighting issues like missing error handling and inconsistent coding style.

Automated Refactoring Service

Automatically refactors code to adhere to guidelines such as avoiding magic numbers and ensuring modular design.

Project Consistency Checker

Checks for consistent coding style, performance, and security across multiple files, avoiding unnecessary updates.

Developer Assistant Extension

Provides real-time feedback on code edits, emphasizing explicit variable names and avoiding unnecessary confirmations.

Code Optimization Platform

Suggests performance improvements and modular design strategies while prioritizing security and version compatibility.

Unit Test Suggestions App

Automatically generates unit tests for new or modified code, focusing on coverage without revealing current implementation.

Version Compatibility Analyzer

Checks code changes for compatibility with specified language or framework versions to ensure smooth integration.

Edge Case Identifier

Scans code to identify potential edge cases and suggests handling strategies for robust error handling.

Context-Aware Code Reviewer

Provides feedback on edits using context-generated files, ensuring no unnecessary confirmations and preserving files.

Modular Design Educator

Educates developers on implementing modular design principles for reusability and maintainability.

Assertion Validator

Checks the presence and correct use of assertions in code within CI/CD pipelines for enhanced validation.

Hardcoded Values Detector

Scans codebases for magic numbers and suggests replacements with named constants for clarity and maintainability.

Error Handling Enhancer

Suggests improvements in error handling mechanisms with recommendations for robust logging practices.

Overview of .cursorrules prompt

The .cursorrules file outlines a set of rules and guidelines to be followed when editing or suggesting changes to code. It emphasizes verifying information, making changes file-by-file, preserving existing code, and avoiding unnecessary confirmations or updates. It advises against using apologies, unnecessary whitespace changes, or summarizing changes made. There is a focus on ensuring real file links are provided, using explicit variable names, and following a consistent coding style. Performance, security, error handling, modular design, version compatibility, edge cases, and test coverage are prioritized. The file discourages the use of “magic numbers” and encourages using assertions to catch errors early.

Updated: March 14, 2025

Developers working on collaborative projects would benefit by establishing clear and efficient code review and update practices, ensuring consistent, secure, and maintainable code quality across the team.

Usefull for: