Skip to content

Commit 1cca543

Browse files
authoredDec 1, 2023
Update PR template to ask for release type (Azure#23528)
* Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md * Update repo question * Update PULL_REQUEST_TEMPLATE.md * Update CONTRIBUTING.md
1 parent faaa193 commit 1cca543

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,15 @@
66

77
## Checklist
88

9+
- **Mandatory**: please state whether this PR targets a [**general** release](../blob/main/CONTRIBUTING.md#target-release-types) / [**public preview**](../blob/main/CONTRIBUTING.md#target-release-types) / [**private preview**]((../blob/main/CONTRIBUTING.md#target-release-types)) / [**engineering build**](../blob/main/CONTRIBUTING.md#target-release-types) of Azure PowerShell?
10+
- `{Enter your answer here}`
911
- [ ] 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:**
1012

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.
1313
* **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.
14+
* For SDK-based development mode, update `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.
16+
* For autorest-based development mode, include the changelog in the PR description.
1617
* 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 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
2218
* **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)
2319
* **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.
2520
* **SHOULD NOT** adjust version of module manually in pull request

‎CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,27 @@ completed checklist.
9090
The following set of guidelines must be adhered to when opening pull requests in the Azure
9191
PowerShell repository.
9292

93+
#### Target Release Types
94+
95+
Here are all types of releases of **Azure PowerShell**. Note that the type of release isn't necessarily aligned to the state of the swagger or service feature.
96+
97+
- **General** release
98+
- This PR targets an [official general release](https://github.com/Azure/azure-powershell/milestones) of Azure PowerShell.
99+
- Target version is `x.y.z`, no suffix.
100+
- Note: versions < 1.0.0 are also included in this category.
101+
- Target branch should be `main` or `generation` depending on the development approach.
102+
- **Preview** release
103+
- **Public preview**
104+
- This PR targets a preview release of Azure PowerShell. It is independent to the normal release cycle.
105+
- Target version is `x.y.z-preview`.
106+
- Note: if the major version is 0, it is considered a general release rather than preview.
107+
- Target branch should not be `main` nor `generation`. Please contact [sprint master](https://github.com/Azure/azure-powershell/milestones) if you are unsure about which branch to target.
108+
- **Private preview** / **Embargoed preview**
109+
- This PR is related to some business secret. It should not be submitted to this repository. Contact [sprint master](https://github.com/Azure/azure-powershell/milestones) for more details.
110+
- **Engineering build**
111+
- This PR does not require any kind of releases. It's for internal or private distribution.
112+
- Target branch should not be `main` nor `generation`. Please contact [sprint master](https://github.com/Azure/azure-powershell/milestones) if you are unsure about which branch to target.
113+
93114
#### General guidelines
94115

95116
The following guidelines must be followed for **every** pull request that is opened.

0 commit comments

Comments
 (0)
Please sign in to comment.