You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+5-10Lines changed: 5 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,15 @@
6
6
7
7
## Checklist
8
8
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}`
9
11
-[ ] 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
12
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.
* 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.
16
17
* 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
22
18
***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
19
***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
20
***SHOULD NOT** adjust version of module manually in pull request
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21Lines changed: 21 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,27 @@ completed checklist.
90
90
The following set of guidelines must be adhered to when opening pull requests in the Azure
91
91
PowerShell repository.
92
92
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
+
93
114
#### General guidelines
94
115
95
116
The following guidelines must be followed for **every** pull request that is opened.
/// An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
1497
+
/// An OData filter expression that describes a subset of usages to return. The
1498
+
/// supported parameter is name.value (name of the metric, can have an or of
/// Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
1975
+
/// Create Cognitive Services Account. Accounts is a resource group wide
1976
+
/// resource type. It holds the keys for developer to access intelligent APIs.
1977
+
/// It's also the resource type for billing.
1972
1978
/// </summary>
1973
1979
/// <param name='resourceGroupName'>
1974
1980
/// The name of the resource group. The name is case insensitive.
/// Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
16
+
/// Create Cognitive Services Account. Accounts is a resource group wide
17
+
/// resource type. It holds the keys for developer to access intelligent APIs.
18
+
/// It's also the resource type for billing.
17
19
/// </summary>
18
20
/// <param name='operations'>
19
21
/// The operations group for this extension method.
/// Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
35
+
/// Create Cognitive Services Account. Accounts is a resource group wide
36
+
/// resource type. It holds the keys for developer to access intelligent APIs.
37
+
/// It's also the resource type for billing.
34
38
/// </summary>
35
39
/// <param name='operations'>
36
40
/// The operations group for this extension method.
/// Regenerates the specified account key for the specified Cognitive Services account.
292
+
/// Regenerates the specified account key for the specified Cognitive Services
293
+
/// account.
286
294
/// </summary>
287
295
/// <param name='operations'>
288
296
/// The operations group for this extension method.
@@ -355,7 +363,9 @@ public static AccountSkuListResult ListSkus(this IAccountsOperations operations,
355
363
/// The name of Cognitive Services account.
356
364
/// </param>
357
365
/// <param name='filter'>
358
-
/// An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
366
+
/// An OData filter expression that describes a subset of usages to return. The
367
+
/// supported parameter is name.value (name of the metric, can have an or of
@@ -375,7 +385,9 @@ public static AccountSkuListResult ListSkus(this IAccountsOperations operations,
375
385
/// The name of Cognitive Services account.
376
386
/// </param>
377
387
/// <param name='filter'>
378
-
/// An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
388
+
/// An OData filter expression that describes a subset of usages to return. The
389
+
/// supported parameter is name.value (name of the metric, can have an or of
390
+
/// multiple names).
379
391
/// </param>
380
392
/// <param name='cancellationToken'>
381
393
/// The cancellation token.
@@ -427,7 +439,9 @@ public static Microsoft.Rest.Azure.IPage<AccountModel> ListModels(this IAccounts
427
439
}
428
440
}
429
441
/// <summary>
430
-
/// Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
442
+
/// Create Cognitive Services Account. Accounts is a resource group wide
443
+
/// resource type. It holds the keys for developer to access intelligent APIs.
444
+
/// It's also the resource type for billing.
431
445
/// </summary>
432
446
/// <param name='operations'>
433
447
/// The operations group for this extension method.
@@ -444,7 +458,9 @@ public static Account BeginCreate(this IAccountsOperations operations, string re
444
458
}
445
459
446
460
/// <summary>
447
-
/// Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
461
+
/// Create Cognitive Services Account. Accounts is a resource group wide
462
+
/// resource type. It holds the keys for developer to access intelligent APIs.
463
+
/// It's also the resource type for billing.
448
464
/// </summary>
449
465
/// <param name='operations'>
450
466
/// The operations group for this extension method.
@@ -505,7 +521,7 @@ public static Account BeginUpdate(this IAccountsOperations operations, string re
505
521
}
506
522
}
507
523
/// <summary>
508
-
/// Deletes a Cognitive Services account from the resource group.
524
+
/// Deletes a Cognitive Services account from the resource group.
509
525
/// </summary>
510
526
/// <param name='operations'>
511
527
/// The operations group for this extension method.
0 commit comments