chore: refine Copilot PR interface review prompt [no-ci]#405
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Refines the repository’s Copilot “PR Interface & Contract Review” prompt to improve consistency and reduce review blind spots when assessing backward compatibility and public-surface changes.
Changes:
- Aligns Step 1 guidance with Step 5 by requiring reviewers to note tests that are added, deleted, or modified to remove a compat case.
- Broadens Tier 6 (“brand-new public type”) collision guidance to include glob/namespace import patterns across languages.
- Adds an explicit fenced code-block language (
markdown) to satisfy markdownlint MD040.
💡 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.
Refines
.github/prompts/pr-interface-review.mdbased on Copilot review feedback raised during the original rollout:Step 1 / Step 5 consistency — Step 1 said "ignore tests except deleted" but Step 5 also requires reviewing added tests that prove compat shims. Broadened Step 1 to cover added, deleted, and modified-to-remove tests. (raised on
deepgram/deepgram-go-sdk#329)Tier 6 broadened — original wording only mentioned same-named local symbols as collision vectors. Now also covers glob/namespace imports (Python
from X import *, Rustuse X::*, Go dot-imports, TypeScriptimport * asdestructuring). (raised ondeepgram/deepgram-js-sdk#495)Fence language — the template fenced block now declares
markdownto satisfy markdownlint MD040. (raised ondeepgram/deepgram-go-sdk#329)Canonical source:
deepgram/dx-stack. Rollout context:docs/copilot-prompts.md.[no-ci]— docs-only refinement to a previously-merged file.