Skip to content

{Repository} Add evidence-based pull request review instructions - #10599

Merged
xuming-ms merged 1 commit into
Azure:mainfrom
isra-fel:review/pr-review-instructions
Nov 18, 2026
Merged

xuming-ms merged 1 commit into
Azure:mainfrom
isra-fel:review/pr-review-instructions

Conversation

@isra-fel

@isra-fel Yeming Liu (isra-fel) commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

🤖 PR Validation — ️✔️ All clear

Breaking Changes Suppressions
️✔️ None ️✔️ None

Generated a pr review skill based on the scrum master loop doc and various docs in cli repo.

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

Not applicable: review-agent instructions only; no az commands or extension releases change.

Description

Add .github/instructions/pr-review.instructions.md as a repository-wide code-review baseline, excluding the cloud agent.

The instructions cover release/version consistency, breaking-change policy, generated AAZ model synchronization, meaningful tests, and CI/release safety. They incorporate a qualitative review of five merged PRs from 2026 (#10473, #10537, #10530, #10581, #10593) and five from 2025 (#8601, #9286, #9344, #9476, #9479):

  • Discover validation reports across PR bodies, comments and checks, and distinguish stale evidence from current-head results.
  • Trace runtime behavior through command registration, validation, custom overrides, serialization, polling and output.
  • Check behavioral test coverage, recording sanitization, and reproducible test prerequisites.
  • Check preview metadata and actual compatibility with the declared minimum CLI version.
  • Revalidate findings against updated diffs and replies while preserving valid index-only releases and accepted follow-ups.

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
    Not run: not applicable; this PR changes only Markdown instructions, not extension code.
  • Have you run python scripts/ci/test_index.py -q locally? (pip install azdev required)
    Not run: not applicable; neither src/index.json nor extension packaging changes.
  • My extension version conforms to the Extension version schema
    Not applicable: no extension release or version change.

For new extensions:

Validation: git diff --cached --check passed. Manually reviewed the instructions against the ten-PR sample and linked policies. No runtime tests or fresh-session agent evaluation were run.

Local pre-commit and pre-push hook checks did not run: both reported Python not found in PATH. The commit and push completed.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 50c27eca-5a83-4d75-85a7-d76fdc1cb00d
Copilot AI balanced review requested due to automatic review settings November 18, 2026 02:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the new repository-wide Azure CLI extension review guidance.

No open issues 🎉

What changed in this PR

Adds a repository-wide code-review baseline for Azure CLI extensions, excluding the cloud agent. The guidance draws on ten merged PRs to promote evidence-based reviews without changing commands or extension releases.

Changes:

  • Defines checks for validation evidence, compatibility, release consistency, and generated AAZ model synchronization.
  • Sets expectations for behavioral tests, recording sanitization, and reproducible test prerequisites.
  • Covers CI safety and revalidation of earlier findings while respecting valid index-only releases and accepted follow-ups.
File Description
.github/​instructions/​pr-review.instructions.md Adds review guidance covering evidence, compatibility, releases, generated code, tests, and CI safety.

Review effort: Balanced

@xuming-ms
xuming-ms merged commit 0ea6ada into Azure:main Nov 18, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants