Skip to content

Commit 038eccb

Browse files
authored
Update PULL_REQUEST_TEMPLATE.md (Azure#15267)
Clean up grammar and clarify the ARM review process.
1 parent 0eeefb8 commit 038eccb

File tree

1 file changed

+29
-21
lines changed

1 file changed

+29
-21
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
</i>
33

44
### Changelog
5-
Please ensure to add changelog with this PR by answering the following questions.
6-
1. What's the purpose of the update?
7-
- [ ] new service onboarding
8-
- [ ] new API version
9-
- [ ] update existing version for new feature
5+
Add a changelog entry for this PR by answering the following questions:
6+
1. What's the purpose of the update?
7+
- [ ] new service onboarding
8+
- [ ] new API version
9+
- [ ] update existing version for new feature
1010
- [ ] update existing version to fix swagger quality issue in s360
11-
- [ ] Other, please clarify
12-
2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
13-
3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
14-
4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
11+
- [ ] Other, please clarify
12+
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.
13+
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
14+
4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
1515
- [ ] SDK of .NET (need service team to ensure code readiness)
1616
- [ ] SDK of Python
1717
- [ ] SDK of Java
@@ -20,7 +20,7 @@ Please ensure to add changelog with this PR by answering the following questions
2020
- [ ] PowerShell
2121
- [ ] CLI
2222
- [ ] Terraform
23-
- [ ] No, no need to refresh for updates in this PR
23+
- [ ] No refresh required for updates in this PR
2424

2525
### Contribution checklist:
2626
- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/bcforapi) of "no breaking changes"
@@ -29,24 +29,32 @@ Please ensure to add changelog with this PR by answering the following questions
2929

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

32-
### ARM API Review Checklist
33-
- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
32+
### ARM API Review Checklist
33+
34+
> **Applicability**: :warning:
35+
>
36+
> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
37+
> - Change to data plane APIs
38+
> - Adding new properties
39+
> - All removals
40+
41+
Otherwise your PR may be subject to ARM review requirements. Complete the following:
42+
- [ ] Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
43+
- Adding a new service
3444
- Adding new API(s)
3545
- Adding a new API version
36-
- [ ] Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
37-
- Adding a new service
46+
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit (including refactoring) and then push new changes, including version updates, in separate commits.
3847

39-
- [ ] Please 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.
48+
- [ ] 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.
4049

4150
- [ ] 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.
4251

4352
### Breaking Change Review Checklist
44-
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi).
45-
46-
- [ ] Removing API(s) in stable version
47-
- [ ] Removing properties in stable version
48-
- [ ] Removing API version(s) in stable version
49-
- [ ] Updating API in stable or public preview version with Breaking Change Validation errors
53+
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi).
54+
- [ ] Removing API(s) in a stable version
55+
- [ ] Removing properties in a stable version
56+
- [ ] Removing API version(s) in a stable version
57+
- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors
5058
- [ ] Updating API(s) in public preview over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews))
5159

5260
**Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Addition 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).

0 commit comments

Comments
 (0)