-
Notifications
You must be signed in to change notification settings - Fork 406
Create generated-code.instructions.md for copilot #9656
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arielshaqed
wants to merge
1
commit into
master
Choose a base branch
from
chore/instruct-copilot-about-generated-code
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||
| ## Generated code | ||||||
|
|
||||||
| Some files in the repository contain generated code. These include: | ||||||
| - All files `*.gen.go`. | ||||||
| - All files under `clients/java`. | ||||||
| - All files under `clients/python`. | ||||||
| - All files under `clients/rust`. | ||||||
|
|
||||||
| DO NOT make any stylistic suggestions to these files. Only make suggestions to these files for actual errors. | ||||||
|
|
||||||
| ### Examples | ||||||
|
|
||||||
| #### Not an error, do NOT report suggest a fix | ||||||
|
|
||||||
| In file clients/java/src/main/java/io/lakefs/clients/sdk/AuthApi.java | ||||||
|
|
||||||
|
|
||||||
| ```java | ||||||
| } else if ( localBasePaths.length > 0 ) { | ||||||
| basePath = localBasePaths[localHostIndex]; | ||||||
| ``` | ||||||
|
|
||||||
| Do NOT comment | ||||||
| > Test is always false. | ||||||
|
|
||||||
| This is generated code, and there is no harm in this code. | ||||||
|
|
||||||
| #### Error, report and suggest a fix | ||||||
|
|
||||||
| If a generated file in clients/python contains code similar to this: | ||||||
|
|
||||||
| ```py | ||||||
| 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. | ||||||
|
||||||
| 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. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammatical error: "do NOT report suggest a fix" should be "do NOT report or suggest a fix"