add copilot instructions #3963
add copilot instructions #3963
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds custom Copilot instructions to guide automated code review for the AWS .NET SDK library. The instructions focus on maintaining backward compatibility, proper versioning, and following best practices.
- Establishes review guidelines for API compatibility, behavioral changes, and platform support
- Defines requirements for dev config files and version bump notations
- Outlines specific checks for generator code changes and automated flagging criteria
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - Check for **changes in behavior** (e.g., logic, side effects, error handling). | ||
| - If behavior changes, ensure it is documented and justified in the PR description. | ||
|
|
||
| ### 3. Dev Config and Versioning |
There was a problem hiding this comment.
I don't think it is even going to begin to understand what this is. You likely need to obtain some information about it since we don't have the memory-bank yet but agree it cannot be huge for this purpose.
There was a problem hiding this comment.
Perhaps the location and a sample of a devconfig file would be enough to start with the possible names.
There was a problem hiding this comment.
i have this other PR #3968 which has info on dev config and contributing. maybe i can referencing that CONTRIBUTING.MD file?
There was a problem hiding this comment.
Yes, that should work. Otherwise it will have no clue what it is.
| - .NET Framework 4.7.2 | ||
|
|
||
| ### 5. General Best Practices | ||
| - Follow .NET and AWS SDK coding standards. |
There was a problem hiding this comment.
What is it going to do with this when we don't have a coding standards doc or even memory bank info for this yet? It may be better to tell it to maintain coding consistency at this point since there are no standard docs.
There was a problem hiding this comment.
good question. So this is assuming that copilot has some already pretrained info on .NET and AWS SDK coding practices. I'm also assuming that during PR review it has context of the files and it can infer existing best practices as well.
you are right though that having a dedicated coding standards doc would help more though. let me know your thoughts.
| - Avoid introducing unused code, dependencies, or files. | ||
| - Ensure all code is properly formatted and linted. | ||
|
|
||
| ### 6. Generator Changes |
There was a problem hiding this comment.
Is it going to understand you are referring to our generator (Doc or code)? I have a feeling it doesn't even know where that is at.
There was a problem hiding this comment.
So this is just based off of existing comments it gave e.g #3949 (review) it seems to know what it is and i believe it can infer (e.g. if file in the generator folder is modified then it refers to the generator)
| - Document any differences, edge cases, or limitations in the PR description. | ||
| - If possible, provide a comparison or summary of key behaviors between the old and new implementations. | ||
|
|
||
| ### 7. General Review Practices |
There was a problem hiding this comment.
Add look for security vulnerabilities
| ## Automated Checks | ||
| - Copilot should flag PRs that: | ||
| - Introduce breaking changes without a major version bump. | ||
| - Lack a dev config file or changelog update. |
There was a problem hiding this comment.
changelog updates come through the devconfig files so it may not understand this is where it needs to see it. Again stressing it would be useful to build out the devconfig section above just a tad more.
Add copilot custom instructions for copilot review. Customizing this file allows us to specifiy what copilot should look for during reviews
See: https://github.blog/changelog/2025-06-13-copilot-code-review-customization-for-all/
Motivation and Context
To improve copilot reviews
Testing
Screenshots (if appropriate)
Types of changes
Checklist
License