docs: add rules to avoid unnecessary changes #21083
Merged
Conversation
This file contains hidden or 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
Add guidelines to prevent common PR feedback issues: - Don't reword existing comments or code unless directly motivated by the task - Don't delete existing comments that explain non-obvious behavior - Add new test cases instead of modifying existing ones Refs #21073
ammario
approved these changes
Dec 3, 2025
Member
ammario
left a comment
There was a problem hiding this comment.
I think the issues in my PR came from my own prompting to clean up the surrounding code, but these are good rules nonetheless.
Member
Author
|
@ammario Ok 😄, at least I've run into comment rewording and variable renaming before. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add guidelines to prevent common PR feedback issues:
Refs #21073