Add review guidelines for sdk.instructions.md #604
Conversation
Clarify review instructions for SDK files.
rshade
added
the
impact/no-changelog-required
Does the PR have any schema changes?Looking good! No breaking changes found. Maintainer note: consult the runbook for dealing with any breaking changes. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #604 +/- ##
=======================================
Coverage 19.89% 19.89%
=======================================
Files 48 48
Lines 5700 5700
=======================================
Hits 1134 1134
Misses 4399 4399
Partials 167 167 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new instruction file to provide guidance on when and how to review SDK-related files, specifically in relation to schema.json changes and auto-generated SDK code.
- New instruction file
.github/sdk.instructions.mdcreated with guidelines about SDK file review requirements - References the
make build_sdkscommand for SDK regeneration - Clarifies that SDK files are auto-generated
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,2 @@ | |||
| If schema.json has changed, verify that the SDK files in this folder have been regenerated by running `make build_sdks`. | |||
| Otherwise, the files in this folder are auto-generated and should not be reviewed. | |||
There was a problem hiding this comment.
The phrase "the files in this folder" is ambiguous since this instruction file is in .github/ but refers to files in the sdk/ folder. Consider making this more explicit: "Otherwise, the files in the sdk/ folder are auto-generated and should not be reviewed."
| Otherwise, the files in this folder are auto-generated and should not be reviewed. | |
| Otherwise, the files in the `sdk/` folder are auto-generated and should not be reviewed. |
iwahbe
left a comment
iwahbe
left a comment
There was a problem hiding this comment.
Is there some standard for .github/sdk.instructions.md? If so, can you link it?
It's not obvious why this is the best way to describe the sdk folder otherwise.
Not really, I wish we had one. We really just need copilot to ignore the whole thing unless the schema changes, but maybe people will just know that the unclean checkout means run |
2 participants
Clarify review instructions for SDK files.