fix: Update .cursorrules about code comments #29219
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR updates the .cursorrules file to instruct AI assistants (specifically Cursor) to respect code comments in the codebase rather than automatically removing them.
- Added rule in
.cursorrulesspecifying to respect all code comments and only remove them if completely irrelevant after a code change - Includes explicit instruction "if unsure, do not remove the comment" to preserve institutional knowledge
- Addresses a specific problem where Cursor AI was frequently suggesting removal of valuable comments
- Helps maintain context and documentation within the codebase that might otherwise be lost
1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -15,5 +15,6 @@ DO NOT GIVE ME HIGH LEVEL SHIT, IF I ASK FOR FIX OR EXPLANATION, I WANT ACTUAL C | |||
| - No need to mention your knowledge cutoff | |||
| - No need to disclose you're an AI | |||
| - Please respect my formatting preferences when you provide code. | |||
| - Please respect all code comments, they're usually there for a reason. Remove them ONLY if they're completely irrelevant after a code change. if unsure, do not remove the comment. | |||
There was a problem hiding this comment.
style: Consider capitalizing 'if' at the beginning of the second sentence for consistency with the rest of the document.
rafaeelaudibert
approved these changes
Feb 25, 2025
dmarticus
approved these changes
Feb 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Cursor constantly want to remove comments left in code, which is no bueno most of the time.
Changes
Add line about comments in .cursorrules.