Updating instructions by mining PRs for feedback#8618
Draft
richardpark-msft wants to merge 2 commits into
Draft
Conversation
…ome commonly found (or uncommonly found) issues we've seen in PRs in azure-dev
richardpark-msft
requested review from
RickWinter,
danieljurek,
tg-msft and
vhvb1989
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s Copilot review instruction set by adding new guidance entries derived from human review feedback on recent PRs, aiming to improve consistency and prevent recurring review misses.
Changes:
- Added Go-focused review guidance around CLI argument/flag precedence and location-scoped filtering behavior.
- Added extension guidance for destructive commands, emphasizing API-contract validation and local state cleanup.
- Expanded documentation guidance for behavior changes (e.g.,
--no-promptsemantics), naming/rebrand considerations, and env-var/config-shape verification.
Show a summary per file
| File | Description |
|---|---|
| .github/instructions/go.instructions.md | Adds new Go PR review guidance around CLI behavior and location-scoped filtering. |
| .github/instructions/extensions.instructions.md | Adds extension review guidance for destructive commands and their end-to-end cleanup behavior. |
| .github/instructions/documentation.instructions.md | Adds doc update triggers and verification guidance; includes a new sources footer. |
Copilot's findings
- Files reviewed: 3/3 changed files
- Comments generated: 2
| - Include code examples where they aid understanding | ||
| - Verify environment-variable docs against source behavior and generated config shapes. Distinguish values that `azd` reads directly from template substitutions, and document Bicep parameter files using the nested `parameters.<name>.value` shape rather than flattened JSON. | ||
|
|
||
| _Sources: PR #8494 https://github.com/Azure/azure-dev/pull/8494#discussion_r3327398519; PR #8561 https://github.com/Azure/azure-dev/pull/8561#pullrequestreview-4451043828; PR #8579 https://github.com/Azure/azure-dev/pull/8579#discussion_r3381280690; PR #8529 https://github.com/Azure/azure-dev/issues/8529#issuecomment-4616281158._ |
Comment on lines
+15
to
+19
| _Source: PR #8519 comments | ||
| https://github.com/Azure/azure-dev/pull/8519#discussion_r3357456060, | ||
| https://github.com/Azure/azure-dev/pull/8519#discussion_r3357464681, | ||
| https://github.com/Azure/azure-dev/pull/8519#discussion_r3357472539, | ||
| https://github.com/Azure/azure-dev/pull/8519#discussion_r3357477998._ |
Member
Author
|
Note for reviewers - this is not the instruction updates final form - we'll want to trim out the references links, etc.. That's just for you to look at, if you want to peek around and see what comments/feedback were used to form the instructions update. |
Member
Author
|
Testing this in #8622 |
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.
This is a first pass with a skill I wrote. It goes through a range of PRs (last 2 months), and then tries to come up with instructions that would catch or give advice similar to the feedback on those PRs (from humans!).
I've left in a few things, but wanted to open up a discussion about the entries, see what feedback you have and (once we get it into an acceptable state) merge it in, which should help with Copilot Code Reviews and on our local box.