Skip to content

Commit 8f0dcbd

Browse files
authored
Merge pull request #8044 from MiYanni/az-cleanup-12-docs
12: Update documentation
2 parents e40a0fd + 0f64e48 commit 8f0dcbd

File tree

10 files changed

+457
-435
lines changed

10 files changed

+457
-435
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Contribute Code or Provide Feedback for Azure PowerShell
22

3-
This repository contains a set of PowerShell cmdlets for developers and administrators to develop, deploy, and manage Microsoft Azure applications.
3+
This repository contains PowerShell cmdlets for developers and administrators to develop, deploy, and manage Microsoft Azure applications.
44

55
## Basics
66

7-
If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines/).
7+
If you would like to become an active contributor to this project, please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines/).
88

99
In the Azure Developer Experience, you are at Step 5:
1010

@@ -74,8 +74,7 @@ You can find all of the pull requests that have been opened in the [Pull Request
7474
To open your own pull request, click [here](https://github.com/Azure/azure-powershell/compare). When creating a pull request, keep the following in mind:
7575
- Make sure you are pointing to the fork and branch that your changes were made in
7676
- Choose the correct branch you want your pull request to be merged into
77-
- The **preview** branch is for active development; changes in this branch will be in the next Azure PowerShell release
78-
- The **master** branch contains a snapshot of the source code at the time of the last release
77+
- The **master** branch is for active development; changes in this branch will be in the next Azure PowerShell release
7978
- The **release-X.X.X** branch is for active development during a release
8079
- The pull request template that is provided **should be filled out**; this is not something that should just be deleted or ignored when the pull request is created
8180
- Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed
@@ -91,7 +90,7 @@ For more information on how to make changes to the SDK for .NET repository and p
9190

9291
A pull request template will automatically be included as a part of your PR. Please fill out the checklist as specified. Pull requests **will not be reviewed** unless they include a properly completed checklist.
9392

94-
The following is a list of guidelines that pull requests opened in the Azure PowerShell repository must adhere to. You can find a more complete discussion of Azure PowerShell design guidelines [here](./documentation/development-docs/azure-powershell-design-guidelines.md).
93+
The following is a list of guidelines that pull requests opened in the Azure PowerShell repository must adhere to. You can find a more complete discussion of Azure PowerShell design guidelines [here](documentation/development-docs/azure-powershell-design-guidelines.md).
9594

9695
#### Cleaning up Commits
9796

@@ -103,17 +102,13 @@ If you find yourself creating a pull request and are unable to see all the chang
103102

104103
If splitting up the pull request is not an option, we recommend **creating individual commits for different parts of the pull request, which can be reviewed individually on GitHub**.
105104

106-
For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click [here](./documentation/development-docs/cleaning-up-commits.md).
105+
For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click [here](documentation/development-docs/cleaning-up-commits.md).
107106

108107
#### Updating the change log
109108

110109
Any changes that are made must be reflected in the respecitve service's change log. This change log will allow customers to easily track what has been changed between releases of a service.
111110

112-
For ARM service projects, the change log is located at `src\ResourceManager\{{service}}\ChangeLog.md`.
113-
114-
For RDFE service projects, the change log is located at `src\ServiceManagement\ChangeLog.md`.
115-
116-
For the Storage data plane project, this change log is located at `src\Storage\ChangeLog.md`.
111+
For ARM service projects, the change log is located at `src/ResourceManager/{{service}}/Commands.{{service}}/ChangeLog.md`.
117112

118113
#### Breaking Changes
119114

@@ -130,7 +125,7 @@ The following guidelines must be followed in **EVERY** pull request that is open
130125
- A description of the changes the pull request makes is included, and a reference to the bug/issue the pull request fixes is included, if applicable
131126
- All files have the Microsoft copyright header
132127
- Cmdlets refer to the management libraries through NuGet references - no dlls are checked in
133-
- The pull request does not introduce [breaking changes](https://github.com/markcowl/azure-powershell/blob/doc1/documentation/changes.md#breaking-change-definition) (unless a major version change occurs in the assembly and module)
128+
- The pull request does not introduce [breaking changes](documentation/breaking-changes/breaking-changes-definition.md) (unless a major version change occurs in the assembly and module)
134129

135130
#### Testing guidelines
136131

@@ -142,7 +137,7 @@ The following guidelines must be followed in **EVERY** pull request that is open
142137
- PowerShell scripts used in tests must do any necessary setup as part of the test or suite setup, and should not use hard-coded values for existing resources
143138
- Test should not use App.config files for settings
144139
- Tests should use the built-in PowerShell functions for generating random names when unique names are necessary - this will store names in the test recording
145-
- Tests should use `Start-Sleep` to pause rather than `Thread.Sleep`
140+
- Tests should use `Wait-Seconds` for PowerShell and `TestUtilities.Wait` for C# to pause rather than `Start-Sleep` or `Thread.Sleep` respectively
146141

147142
#### Cmdlet signature guidelines
148143

@@ -153,8 +148,8 @@ The following guidelines must be followed in pull requests that add, edit, or re
153148
- When a verb you would like to use is not in the list of approved verbs, or to get ideas on how to use verbs, consult the [Approved Verbs for Windows PowerShell Commands](https://msdn.microsoft.com/en-us/library/ms714428\(v=vs.85\).aspx) documentation where you will find descriptions of approved verbs as well as related verbs in the comments so that you can find one appropriate for your command
154149
- Cmdlet noun name uses the AzureRm prefix for management cmdlets, and the Azure prefix for data plane cmdlets
155150
- Cmdlet specifies the `OutputType` attribute; if the cmdlet produces no output, it should have an `OutputType` of `bool` and implement a `PassThrough` parameter
156-
- If the cmdlet makes changes or has side effects, it should implement `ShouldProcess` and have `SupportsShouldProcess = true` specified in the cmdlet attribute. See a discussion about correct `ShouldProcess` implementation [here](https://gist.github.com/markcowl/338e16fe5c8bbf195aff9f8af0db585d#what-is-the-change).
157-
- Cmdlets should derive from [`AzureRmCmdlet`](src/ResourceManager/Common/Commands.ResourceManager.Common/AzureRMCmdlet.cs) class for management cmdlets, and [`AzureDataCmdlet`](src/Common/Commands.Common/AzureDataCmdlet.cs) for data cmdlets
151+
- If the cmdlet makes changes or has side effects, it should implement `ShouldProcess` and have `SupportsShouldProcess = true` specified in the cmdlet attribute. See a discussion about correct `ShouldProcess` implementation [here](documentation/development-docs/should-process-confirm-impact.md).
152+
- Cmdlets should derive from [`AzureRmCmdlet`](https://github.com/Azure/azure-powershell-common/blob/master/src/ResourceManager/Version2016_09_01/AzureRMCmdlet.cs) class for management cmdlets, and [`AzureDataCmdlet`](https://github.com/Azure/azure-powershell-common/blob/master/src/Common/AzureDataCmdlet.cs) for data cmdlets
158153
- If multiple parameter sets are implemented, the cmdlet should specify a `DefaultParameterSetName` in its cmdlet attribute
159154

160155
#### Cmdlet parameter guidelines

0 commit comments

Comments
 (0)