Skip to content

Commit 648b58d

Browse files
heathsFredericHeem
authored andcommitted
Highlight required actions in PR templates (Azure#18681)
Also includes a few other markdown fix-ups.
1 parent 4f92b31 commit 648b58d

File tree

2 files changed

+25
-26
lines changed

2 files changed

+25
-26
lines changed
Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ARM API Information (Control Plane)
2-
3-
<i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow.
2+
3+
<i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow.
44
</i>
55

66
### Changelog
@@ -13,22 +13,22 @@ Add a changelog entry for this PR by answering the following questions:
1313
- [ ] Other, please clarify
1414
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
1515
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
16-
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
16+
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
1717

1818
### Contribution checklist (MS Employees Only):
19-
- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/AzBreakingChangesPolicy) of "no breaking changes"
19+
- [ ] I commit to follow the [Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy) of "no breaking changes"
2020
- [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow.
2121
- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and errors have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix)
2222

2323
If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview).
2424

25-
### ARM API Review Checklist
25+
### ARM API Review Checklist
2626

27-
> **Applicability**: :warning:
27+
> **Applicability**: :warning:
2828
>
2929
> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
30-
> - Change to data plane APIs
31-
> - Adding new properties
30+
> - Change to data plane APIs
31+
> - Adding new properties
3232
> - All removals
3333
3434
Otherwise your PR may be subject to ARM review requirements. Complete the following:
@@ -40,14 +40,13 @@ Otherwise your PR may be subject to ARM review requirements. Complete the follow
4040

4141
- [ ] Ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board.
4242

43-
- [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under <ins>Azure Resource Manager service</ins>) from IcM and reach out to them.
43+
- [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under <ins>Azure Resource Manager service</ins>) from IcM and reach out to them.
44+
45+
### Breaking Change Review Checklist
46+
If you have any breaking changes as defined in the [Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy/), request approval from the Breaking Change Review Board.
4447

45-
### Breaking Change Review Checklist
46-
If you have any breaking changes as defined in the [Breaking Change Policy](http://aka.ms/AzBreakingChangesPolicy/), request approval from the Breaking Change Review Board.
47-
4848
**Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Additional details on the process and office hours are on the [Breaking Change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes).
49-
49+
5050
NOTE: To update API(s) in public preview for over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews))
5151

5252
Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview).
53-
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
# Data Plane API - Pull Request
2-
This PR template is for Data Plane APIs only.
2+
<!-- 🚨🚨🚨 Replace this line with a summary and reason for these changes to your data plane API 🚨🚨🚨 -->
33

44
## API Info: The Basics
55
Most of the information about your service should be captured in the issue that serves as your [*engagement record*](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/271/Azure-REST-API-Stewardship?anchor=rest-api-stewardship-process).
66

7-
* Link to engagement record issue:
7+
* Link to engagement record issue:
88

99
Is this review for (select one):
1010

1111
- [ ] a private preview
1212
- [ ] a public preview
13-
- [ ] GA release
13+
- [ ] GA release
1414

1515
### Change Scope
1616
<sup>This section will help us focus on the specific parts of your API that are new or have been modified. <br/>Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated. </sup>
17-
* Design Document:
18-
* Previous Open API Doc:
17+
* Design Document:
18+
* Previous Open API Doc:
1919
* Updated paths:
20-
21-
## :grey_question: Got questions? Need additional info?? We are here to help!
20+
21+
## Got questions? Need additional info?? We are here to help!
2222

2323
<details>
2424
<summary> Contact us!</summary>
2525

2626
The [Azure API Review Board](https://aka.ms/azapi) is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our [wiki](https://aka.ms/azapi).
27-
* :speech_balloon: [Teams Channel](https://teams.microsoft.com/l/channel/19%3a3ebb18fded0e47938f998e196a52952f%40thread.tacv2/General?groupId=1a10b50c-e870-4fe0-8483-bf5542a8d2d8&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47)
28-
* :love_letter: [email](mailto://[email protected])
27+
* 💬 [Teams Channel](https://teams.microsoft.com/l/channel/19%3a3ebb18fded0e47938f998e196a52952f%40thread.tacv2/General?groupId=1a10b50c-e870-4fe0-8483-bf5542a8d2d8&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47)
28+
* 💌 [email](mailto://[email protected])
2929

3030
</details>
3131

3232
<details>
3333
<summary>Click here for links to tools, specs, guidelines & other good stuff</summary>
34-
34+
3535
### Tooling
3636
* [Open API validation tools](https://aka.ms/swaggertools) were run on this PR. Go here to see [how to fix errors](https://aka.ms/ci-fix)
3737
* [Spectral Linting](https://aka.ms/style)
@@ -40,9 +40,9 @@ The [Azure API Review Board](https://aka.ms/azapi) is dedicated to helping you c
4040
### Guidelines & Specifications
4141
* [Azure REST API Guidelines](https://aka.ms/guidelines)
4242
* [OpenAPI Style Guidelines](https://aka.ms/style)
43-
* [Azure Breaking Change Policy](http://aka.ms/bcforapi)
43+
* [Azure Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy)
4444

4545
### Helpful Links
4646
* [Azure DevTools Wiki](https://aka.ms/azapi)
47-
47+
4848
</details>

0 commit comments

Comments
 (0)