chore: add Copilot prompt for PR interface review [no-ci]#156
Merged
lukeocodes merged 1 commit intomainfrom May 6, 2026
Merged
chore: add Copilot prompt for PR interface review [no-ci]#156lukeocodes merged 1 commit intomainfrom
lukeocodes merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a reusable GitHub Copilot prompt file to guide systematic “public interface/contract” reviews for PRs that modify exposed surfaces (types, schemas, exports, wire formats, flags), focusing on compatibility risk classification and shim/coverage auditing.
Changes:
- Introduces a structured, step-by-step interface/contract review checklist with a 6-tier compatibility risk taxonomy.
- Provides a per-interface reporting template plus a catalog of common subtle breaking-change patterns to proactively check.
- Adds guidance for auditing test additions/removals relevant to compatibility shims.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
GregHolmes
approved these changes
May 6, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds
.github/prompts/pr-interface-review.md— a Copilot prompt file for systematic per-interface review of PRs that touch the public surface (types, schemas, exported symbols, wire formats, CLI flags).The prompt classifies every signature change into one of six tiers (🚨 breaking through 🆕 brand-new), flags compat measures already taken, and calls out gaps that remain. Specifically catches subtle failure modes — class→alias collapse, read-side vs write-side compat, default-value flips, enum widening, async/sync flips, generic variance changes.
Canonical source and rollout context:
deepgram/dx-stack.[no-ci]— docs-only addition.