-
Notifications
You must be signed in to change notification settings - Fork 868
Add s3-specific instructions for copilot #4044
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
Conversation
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.
Pull Request Overview
This PR adds Copilot-specific instructions for reviewing S3 generation pull requests. The document provides guidelines for reviewing code changes that convert custom S3 code to generated code in the AWS .NET SDK.
Key Changes
- Adds comprehensive documentation for S3 generation PR review process
- Explains the difference between custom and generated S3 code files
- Provides specific guidelines to identify breaking changes during S3 code generation
can/should you move the existing instructions inside the same copilot instructions folder too to be consistent? and do we need to rename the existing instructions to copilot instructions general? or something like that. just want to make sure we follow some consistent pattern. |
@@ -0,0 +1,37 @@ | |||
--- |
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.
the name of the file i think should follow https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions#creating-custom-instructions
s3.instructions.md
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.
done.
actually nvrmind this. i just checked https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions#creating-custom-instructions repo wide instructions i think should stay where they are |
the Aspire repo left the default instructions in the root of the |
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.
Approved to trial this but we shouldn't be adding temporary project specific instructions to main. Any potential adjustments to this prompt are also going to require additional PRs and reviews from two developers.
Description
This is a set of instructions for copilot that applies to any file changed in S3 (for s3 generation PRs)
Motivation and Context
This will help us catch breaking changes.
Testing
I followed the docs and also I took a look at Aspire and how they did it to make sure it applies to specific file paths and general folder structure:
https://github.com/dotnet/aspire/blob/main/.github/instructions/xmldoc.instructions.md
Screenshots (if appropriate)
Types of changes
Checklist
License