GitHub Code Quality .cursorrules prompt file

Author: meowso

What you can build

Automated Code Review Tool: An app that automatically reviews code and flags potential issues based on the rules provided. It ensures that code adheres to best practices, such as avoiding assumptions, verifying information, and making precise file-by-file changes.Collaborative Coding Platform: A platform that enforces coding rules while enabling multiple developers to work on a project simultaneously. It provides real-time feedback on code changes, focusing on preserving existing code and avoiding unnecessary updates.Code Documentation Assistant: A tool that helps developers write better documentation without summaries or unnecessary confirmations. It guides users to provide instructions and documentation that are clear and evidence-backed.Error-Free Coding Mentor: An educational service that trains developers in best coding practices by providing real-time feedback following the provided rules. It discourages bad habits such as guessing, unnecessary confirmations, and whitespace suggestions.Code Consistency Checker: A tool that scans codebases to ensure consistency and adherence to coding standards, such as no apologies or confirmation requests in code comments and using single chunk edits for clarity.Version Control Enhancer: A version control system add-on that highlights any deviations from the coding rules during commit processes and encourages adherence before changes are pushed to repositories.Quality Assurance Plugin: A plugin for IDEs that offers quality checks aligned with the listed rules. It provides suggestions to maintain code integrity and development efficiency without unnecessary changes or inventions.Real File Linker: A service that automates linking code documentation to the actual files instead of placeholders like x.md, ensuring that developers have access to accurate resources.

Benefits

Synopsis

Developers working on code review tools could use this prompt to build a tool that automatically provides feedback on code adherence to specified guidelines.

Overview of .cursorrules prompt

The .cursorrules file outlines a set of customizable rules designed to guide developers when making changes to code or documentation. Each rule specifies a pattern using regex to match specific words or phrases, and provides a message to advise or remind the developer of best practices. The rules cover various aspects such as verifying information, avoiding unnecessary comments or confirmations, preserving existing code, and ensuring edits are concise. The file aims to maintain code quality, clarity, and efficiency by enforcing these guidelines during the development and documentation process.

.cursorrules Content

{"rules": [{"name": "Verify Information","pattern": "(?i)\b(assume|assumption|guess|speculate)\b","message": "Always verify information before presenting it. Do not make assumptions or speculate without clear evidence."},{"name": "File-by-File Changes","pattern": "// MULTI-FILE CHANGE:","message": "Make changes file by file and give me a chance to spot mistakes"},{"name": "No Apologies","pattern": "(?i)\b(sorry|apologize|apologies)\b","message": "Never use apologies"},{"name": "No Understanding Feedback","pattern": "(?i)\b(understand|understood|got it)\b","message": "Avoid giving feedback about understanding in comments or documentation"},{"name": "No Whitespace Suggestions","pattern": "(?i)\b(whitespace|indentation|spacing)\b","message": "Don't suggest whitespace changes"},{"name": "No Summaries","pattern": "(?i)\b(summary|summarize|overview)\b","message": "Don't summarize changes made"},{"name": "No Inventions","pattern": "(?i)\b(suggest|recommendation|propose)\b","message": "Don't invent changes other than what's explicitly requested"},{"name": "No Unnecessary Confirmations","pattern": "(?i)\b(make sure|confirm|verify|check)\b","message": "Don't ask for confirmation of information already provided in the context"},{"name": "Preserve Existing Code","pattern": "(?i)\b(remove|delete|eliminate|destroy)\b","message": "Don't remove unrelated code or functionalities. Pay attention to preserving existing structures."},{"name": "Single Chunk Edits","pattern": "(?i)\b(first|then|next|after that|finally)\b","message": "Provide all edits in a single chunk instead of multiple-step instructions or explanations for the same file"},{"name": "No Implementation Checks","pattern": "(?i)\b(make sure|verify|check|confirm) (it's|it is|that) (correctly|properly) implemented\b","message": "Don't ask the user to verify implementations that are visible in the provided context"},{"name": "No Unnecessary Updates","pattern": "(?i)\b(update|change|modify|alter)\b.*\bno changes\b","message": "Don't suggest updates or changes to files when there are no actual modifications needed"},{"name": "Provide Real File Links","pattern": "(?i)\b(file|in)\b.*\b(x\.md)\b","message": "Always provide links to the real files, not x.md"},{"name": "No Previous x.md Consideration","pattern": "(?i)\b(previous|earlier|last)\b.*\bx\.md\b","message": "Do not consider any previous x.md files in your memory. Complain if the contents are the same as previous runs."},{"name": "No Current Implementation","pattern": "(?i)\b(current|existing)\s+(implementation|code)\b","message": "Don't show or discuss the current implementation unless specifically requested"},{"name": "Check x.md Content","pattern": "(?i)\b(file|content|implementation)\b","message": "Remember to check the x.md file for the current file contents and implementations"}]}