|
6 | 6 |
|
7 | 7 | ## Checklist
|
8 | 8 |
|
9 |
| -- [ ] I have read the [_Submitting Changes_](../blob/master/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](../blob/master/CONTRIBUTING.md) |
10 |
| -- [ ] The title of the PR is clear and informative |
11 |
| -- [ ] The appropriate `ChangeLog.md` file(s) has been updated: |
12 |
| - - For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md` |
13 |
| - - A snippet outlining the change(s) made in the PR should be written under the `## Upcoming Release` header -- no new version header should be added |
14 |
| -- [ ] The PR does not introduce [breaking changes](../blob/master/documentation/breaking-changes/breaking-changes-definition.md) |
15 |
| -- [ ] If applicable, the changes made in the PR have proper test coverage |
16 |
| -- [ ] For public API changes to cmdlets: |
17 |
| - - [ ] a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (_Microsoft internal only_) |
18 |
| - - {Please put the link here} |
19 |
| - - [ ] the markdown help files have been regenerated using the commands listed [here](../blob/master/documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module) |
| 9 | +- [ ] Check this box to confirm: **I have read the [_Submitting Changes_](../blob/main/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](../blob/main/CONTRIBUTING.md) and reviewed the following information:** |
| 10 | + |
| 11 | +* **SHOULD** select appropriate branch. Cmdlets from Autorest.PowerShell should go to [`generation`](https://github.com/Azure/azure-powershell/tree/generation) branch. |
| 12 | +* **SHOULD** make the title of PR clear and informative, and in the present imperative tense. |
| 13 | +* **SHOULD** update `ChangeLog.md` file(s) appropriately |
| 14 | + * For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md` |
| 15 | + * A snippet outlining the change(s) made in the PR should be written under the `## Upcoming Release` header in the past tense. Add changelog in description section if PR goes into [`generation`](https://github.com/Azure/azure-powershell/tree/generation) branch. |
| 16 | + * Should **not** change `ChangeLog.md` if no new release is required, such as fixing test case only. |
| 17 | +* **SHOULD** have approved design review for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr) ([_Microsoft internal only_](../blob/main/CONTRIBUTING.md#onboarding)) with following situations |
| 18 | + * Create new module from the scratch |
| 19 | + * Create new resource types which are not easy to conform to [Azure PowerShell Design Guidelines](../blob/main/documentation/development-docs/design-guidelines) |
| 20 | + * Create new resource type which name doesn't use module name as prefix |
| 21 | + * Have design question before implementation |
| 22 | +* **SHOULD** regenerate markdown help files if there is cmdlet API change. [Instruction](../blob/main/documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module) |
| 23 | +* **SHOULD** have proper test coverage for changes in pull request. |
| 24 | +* **SHOULD NOT** introduce [breaking changes](../blob/main/documentation/breaking-changes/breaking-changes-definition.md) in Az minor release except preview version. |
| 25 | +* **SHOULD NOT** change version of module in pull request |
0 commit comments