Create generated-code.instructions.md for copilot #9656
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
Instruct copilot to review generated code better than it does today.
arielshaqed
added
pr/merge-if-approved
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation guidelines for reviewing generated code in the repository. The document establishes rules to avoid stylistic suggestions on generated code while still reporting actual errors.
- Defines which files contain generated code (*.gen.go, clients/java, clients/python, clients/rust)
- Establishes that only actual errors (not stylistic issues) should be reported in generated code
- Provides examples distinguishing harmless generated code from security vulnerabilities
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Examples | ||
|
|
||
| #### Not an error, do NOT report suggest a fix |
There was a problem hiding this comment.
Grammatical error: "do NOT report suggest a fix" should be "do NOT report or suggest a fix"
Suggested change
| #### Not an error, do NOT report suggest a fix | |
| #### Not an error, do NOT report or suggest a fix |
| sql_statement = s"SELECT $columns FROM $table LIMIT 1" | ||
| ``` | ||
|
|
||
| then it may be susceptible to SQL injection. Report it unless variables `column` and `table` are very clearly safe to use. |
There was a problem hiding this comment.
Inconsistent variable naming: The text refers to "variables column and table" but the code example uses $columns and $table. The variable name should be columns (plural) to match the code.
Suggested change
| then it may be susceptible to SQL injection. Report it unless variables `column` and `table` are very clearly safe to use. | |
| then it may be susceptible to SQL injection. Report it unless variables `columns` and `table` are very clearly safe to use. |
nopcoder
requested changes
Nov 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Instruct copilot to review generated code better than it does today.
(The "do not" example actually occurred today, and I don't like it).