Skip to content

Conversation

peterrsongg
Copy link
Contributor

@peterrsongg peterrsongg commented Oct 13, 2025

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have read the README document
  • I have added tests to cover my changes
  • All new and existing tests passed

License

  • I confirm that this pull request can be released under the Apache 2 license

@peterrsongg peterrsongg changed the base branch from main to development October 13, 2025 23:54
@GarrettBeatty GarrettBeatty requested a review from Copilot October 14, 2025 00:21
Copy link
Contributor

@Copilot Copilot AI left a 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

@GarrettBeatty GarrettBeatty self-requested a review October 14, 2025 00:23
@peterrsongg peterrsongg requested review from boblodgett and removed request for GarrettBeatty October 14, 2025 00:23
@GarrettBeatty
Copy link
Contributor

GarrettBeatty commented Oct 14, 2025

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 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

@GarrettBeatty
Copy link
Contributor

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.

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

@GarrettBeatty GarrettBeatty self-requested a review October 14, 2025 00:31
@peterrsongg
Copy link
Contributor Author

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.

the Aspire repo left the default instructions in the root of the .github directory so I left it as such.

Copy link
Contributor

@boblodgett boblodgett left a 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.

@peterrsongg peterrsongg merged commit 3633a3f into development Oct 16, 2025
3 checks passed
@peterrsongg peterrsongg deleted the petesong/s3-copilot-instructions branch October 16, 2025 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants