Skip to content

Reposition Step 2 guide link in PR template for better discoverability #40302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
Copilot wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Reposition Step 2 guide link in PR template for better discoverability #40302

Copilot wants to merge 8 commits into from
+522 −9

Conversation

Copy link
Contributor

Copilot AI commented Feb 10, 2026 •
edited
Loading

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Step 2 Details: For detailed information about the ARM API changes review process (Step 2), including ARM Modelling Review requirements, see the Step 2: ARM Review Guide.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • Improve PR template UX by repositioning Step 2 guide link

Description

The Step 2 guide link now appears immediately after the workflow introduction text and before the diagram image, improving discoverability.

Change:

Please understand this diagram before proceeding...

**Step 2 Details**: For detailed information... [link]

![workflow_diagram]

Previously positioned after the diagram, the link is now surfaced earlier in the reading flow where users expect contextual guidance.

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR. See the Step 2: ARM Review Guide for details on what to expect.
  • A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), including ARM Modelling Review requirements, see the Step 2: ARM Review Guide and https://aka.ms/azsdk/pr-arm-review.
  • If you need to schedule ARM Modelling Office Hours, visit https://aka.ms/azsdk/arm-modelling-office-hours.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
  • For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 4 commits February 10, 2026 21:10
@tejaswiMinnu
Add ARMModellingReviewRequired label support to PR workflow
148273b 
- Add ARMModellingReviewRequired to ReviewRequiredLabel typedef
- Add ARMModelling check type to breakingChangesCheckType
- Update getBlockedOnVersioningPolicy to check for pending ARM modelling review
- Add ARMModelling-Approved-OfficeHours approval label
- Add troubleshooting guide for ARM modelling review requirement
- Add label rules for NotReadyForARMReview when ARMModellingReviewRequired is present
- Update notReadyForArmReviewReason to provide specific guidance for modelling review

Co-authored-by: tejaswiMinnu <[email protected]>
@tejaswiMinnu
Add ARM Modelling Review documentation and fix TypeScript typedef
2d5b203 
- Create comprehensive ARM Modelling Review process documentation
- Fix TypeScript typedef to include ValidARMModellingApproval in approvalLabels
- Document the workflow integration and troubleshooting guide
- All tests pass and linting is clean

Co-authored-by: tejaswiMinnu <[email protected]>
@tejaswiMinnu
Add ARM Modelling Review workflow diagram
33c57ee 
- Create detailed Mermaid flowchart showing the complete workflow
- Document key states and label transitions
- Show integration with other review requirements
- Clarify parallel review processes

Co-authored-by: tejaswiMinnu <[email protected]>
@tejaswiMinnu
Apply Prettier formatting to code
f8f7991 
- Format labelling.js and tsgs.js with Prettier
- All checks pass: 464 tests passed, linting clean

Co-authored-by: tejaswiMinnu <[email protected]>
Copilot AI changed the title [WIP] Add ARM modelling review required label to PR workflow Add ARMModellingReviewRequired label to enforce office hours review Feb 10, 2026
Copilot AI requested a review from tejaswiMinnu February 10, 2026 21:18
@tejaswiMinnu
Add office hours meeting link to ARM Modelling Review guidance
29a09fe 
- Add armModellingOfficeHoursHref constant with link to aka.ms/azsdk/arm-modelling-office-hours
- Update armModellingReviewTsg to include meeting link
- Update notReadyForArmReviewReason to include meeting link and scheduling info
- Update documentation with direct link to office hours page
- All tests pass (24/24)

Co-authored-by: tejaswiMinnu <[email protected]>
Copilot AI changed the title Add ARMModellingReviewRequired label to enforce office hours review Add office hours meeting link for ARMModellingReviewRequired workflow Feb 10, 2026
@tejaswiMinnu
Add comprehensive Step 2 ARM Review documentation
0356082 
- Create pr-workflow-step2-arm-review.md with detailed Step 2 workflow
- Include ARM Modelling Review process in Step 2 context
- Add workflow diagram, labels table, timeframes, and troubleshooting
- Update control_plane_template.md to reference Step 2 guide
- Add office hours link directly in Getting Help section
- Link Step 2 guide in due diligence checklist

Co-authored-by: tejaswiMinnu <[email protected]>
Copilot AI changed the title Add office hours meeting link for ARMModellingReviewRequired workflow Add comprehensive Step 2 documentation for PR workflow diagram Feb 10, 2026
@tejaswiMinnu
Move Step 2 details before workflow diagram image
9394c60 
- Reposition Step 2 details link to appear immediately after introductory text
- Now appears before diagram image for better visibility
- Helps users understand Step 2 before viewing the workflow diagram

Co-authored-by: tejaswiMinnu <[email protected]>
Copilot AI changed the title Add comprehensive Step 2 documentation for PR workflow diagram Reposition Step 2 guide link in PR template for better discoverability Feb 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tejaswiMinnu tejaswiMinnu Awaiting requested review from tejaswiMinnu

@weshaggard weshaggard Awaiting requested review from weshaggard weshaggard will be requested when the pull request is marked ready for review weshaggard is a code owner

@mikeharder mikeharder Awaiting requested review from mikeharder mikeharder will be requested when the pull request is marked ready for review mikeharder is a code owner

@benbp benbp Awaiting requested review from benbp benbp will be requested when the pull request is marked ready for review benbp is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@tejaswiMinnu tejaswiMinnu

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tejaswiMinnu