Skip to content

Commit

Permalink
change from dev to master
Browse files Browse the repository at this point in the history
  • Loading branch information
maddieclayton committed Nov 30, 2018
1 parent 51cefc8 commit 8e88b85
Show file tree
Hide file tree
Showing 13 changed files with 43 additions and 44 deletions.
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

## Checklist

- [ ] I have read the [_Submitting Changes_](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md)
- [ ] I have read the [_Submitting Changes_](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md)
- [ ] The title of the PR is clear and informative
- [ ] The appropriate [change log has been updated](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#updating-the-change-log)
- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-changes-definition.md)
- [ ] The appropriate [change log has been updated](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#updating-the-change-log)
- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/master/documentation/breaking-changes/breaking-changes-definition.md)
- [ ] If applicable, the changes made in the PR have proper test coverage
- [ ] For public API changes to cmdlets:
- [ ] the changes have gone through a [cmdlet design review](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (Microsoft internal partners only)
- [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md)
- [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md)
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@ You can find all of the pull requests that have been opened in the [Pull Request
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:
- Make sure you are pointing to the fork and branch that your changes were made in
- Choose the correct branch you want your pull request to be merged into
- The **dev** branch is for active development; changes in this branch will be in the next Azure PowerShell release
- The **master** branch contains a snapshot of the source code at the time of the last release
- The **master** branch is for active development; changes in this branch will be in the next Azure PowerShell release
- The **release-X.X.X** branch is for active development during a release
- 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
- Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed
Expand Down Expand Up @@ -128,7 +127,7 @@ The following guidelines must be followed in **EVERY** pull request that is open
- 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
- All files have the Microsoft copyright header
- Cmdlets refer to the management libraries through NuGet references - no dlls are checked in
- The pull request does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-changes-definition.md) (unless a major version change occurs in the assembly and module)
- The pull request does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/master/documentation/breaking-changes/breaking-changes-definition.md) (unless a major version change occurs in the assembly and module)

#### Testing guidelines

Expand All @@ -151,8 +150,8 @@ The following guidelines must be followed in pull requests that add, edit, or re
- 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
- Cmdlet noun name uses the AzureRm prefix for management cmdlets, and the Azure prefix for data plane cmdlets
- Cmdlet specifies the `OutputType` attribute; if the cmdlet produces no output, it should have an `OutputType` of `bool` and implement a `PassThrough` parameter
- 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://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/should-process-confirm-impact.md).
- Cmdlets should derive from [`AzureRmCmdlet`](https://github.com/Azure/azure-powershell-common/blob/dev/src/ResourceManager/Version2016_09_01/AzureRMCmdlet.cs) class for management cmdlets, and [`AzureDataCmdlet`](https://github.com/Azure/azure-powershell-common/blob/dev/src/Common/AzureDataCmdlet.cs) for data cmdlets
- 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://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/should-process-confirm-impact.md).
- 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
- If multiple parameter sets are implemented, the cmdlet should specify a `DefaultParameterSetName` in its cmdlet attribute

#### Cmdlet parameter guidelines
Expand Down Expand Up @@ -180,4 +179,4 @@ The following guidelines must be followed in pull requests that make changes to
- No parameter is of type `object`
- Each management cmdlet should have a parameter set that takes `ResourceGroupName` and `Name` from the pipeline by property value
- For a given resource type, it should be possible to pipe the output of `Get` and `New` cmdlets to the input of `Set`, `Update`, `Remove` and other action cmdlets for that resource
- More information can be found [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/piping-in-powershell.md)
- More information can be found [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/piping-in-powershell.md)
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For more detailed instructions on using Azure PowerShell, please refer to the [g

### Log in to Azure

To connect to Azure, use the [`Connect-AzAccount`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzAccount.md) cmdlet.
To connect to Azure, use the [`Connect-AzAccount`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzAccount.md) cmdlet.

```powershell
# Interactive login - you will get a dialog box asking for your Azure credentials
Expand All @@ -76,7 +76,7 @@ Connect-AzAccount -Environment AzureChinaCloud

### Getting and setting your session context

To view the context you are using in the current session, which contains the subscription and tenant, use the [`Get-AzContext`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Get-AzContext.md) cmdlet:
To view the context you are using in the current session, which contains the subscription and tenant, use the [`Get-AzContext`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Get-AzContext.md) cmdlet:

```powershell
# Get the context you are currently using
Expand All @@ -86,7 +86,7 @@ Get-AzContext
Get-AzContext -ListAvailable
```

To get the subscriptions in a tenant, use the [`Get-AzSubscription`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Get-AzSubscription.md) cmdlet:
To get the subscriptions in a tenant, use the [`Get-AzSubscription`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Get-AzSubscription.md) cmdlet:

```powershell
# Get all of the subscriptions in your current tenant
Expand All @@ -96,7 +96,7 @@ Get-AzSubscription
Get-AzSubscription -TenantId $TenantId
```

To change the subscription that you are using for your current context, use the [`Set-AzContext`](https://github.com/Azure/azure-powershell/blob/dev/src/ResourceManager/Profile/Commands.Profile/help/Set-AzContext.md) cmdlet:
To change the subscription that you are using for your current context, use the [`Set-AzContext`](https://github.com/Azure/azure-powershell/blob/master/src/ResourceManager/Profile/Commands.Profile/help/Set-AzContext.md) cmdlet:

```powershell
# Set the context to a specific subscription
Expand Down Expand Up @@ -155,7 +155,7 @@ If there is a feature you would like to see in Azure PowerShell, please use the

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

More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md) and the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-developer-guide.md) folder.
More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md) and the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-developer-guide.md) folder.

## Learn More

Expand Down
2 changes: 1 addition & 1 deletion build.proj
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@
</Target>

<Target Name="StaticAnalysisErrorMessage">
<Error Text="StaticAnalysis has failed. Please follow the instructions on this doc: https://github.com/Azure/azure-powershell/blob/dev/documentation/Debugging-StaticAnalysis-Errors.md"/>
<Error Text="StaticAnalysis has failed. Please follow the instructions on this doc: https://github.com/Azure/azure-powershell/blob/master/documentation/Debugging-StaticAnalysis-Errors.md"/>
</Target>

<Target Name="ChangeLogCheck">
Expand Down
4 changes: 2 additions & 2 deletions documentation/Debugging-StaticAnalysis-Errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ _Note_: Sometimes the error listed in the .csv file can be a false positive (for
We take breaking changes very seriously, so please be mindful about the violations that you suppress in our repo.

### Signature Issues
Signature issues occur when your cmdlets do not follow PowerShell standards. Please check [this page](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/azure-powershell-design-guidelines.md) to ensure you are following PowerShell guidelines. Issues with severity 0 or 1 must be addressed, while issues with severity 2 are advisory. If you have an issue with severity 0 or 1 that has been approved by the Azure PowerShell team, you can suppress them following these steps:
Signature issues occur when your cmdlets do not follow PowerShell standards. Please check [this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-design-guidelines.md) to ensure you are following PowerShell guidelines. Issues with severity 0 or 1 must be addressed, while issues with severity 2 are advisory. If you have an issue with severity 0 or 1 that has been approved by the Azure PowerShell team, you can suppress them following these steps:

- Download the `SignatureIssues.csv` file from the Jenkins build
- Open the file using a text editor (such as VS Code) and copy each of the errors you'd like to suppress
Expand All @@ -51,4 +51,4 @@ Signature issues occur when your cmdlets do not follow PowerShell standards. Pl
- Push the changes to the .csv file and ensure the errors no longer show up in the `SignatureIssues.csv` file output from the Jenkins build.

### Help Issues
Most help issues that cause StaticAnalysis to fail occur when help has not been added for a particular cmdlet. If you have not generated help for your new cmdlets, please follow the instructions [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md). If this is not the issue, follow the steps listed under "Remediation" for each violation listed in HelpIssues.csv.
Most help issues that cause StaticAnalysis to fail occur when help has not been added for a particular cmdlet. If you have not generated help for your new cmdlets, please follow the instructions [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md). If this is not the issue, follow the steps listed under "Remediation" for each violation listed in HelpIssues.csv.
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ $job | Wait-Job
$subcriptions = $job | Receive-Job
````

To set a custom job name, please use [SetBackgroupJobDescription(string name)](https://github.com/Azure/azure-powershell-common/blob/dev/src/Common/AzurePSCmdlet.cs#L810). The default job description is: "Long Running Operation for '{cmdlet name}' on resource '{resource name}'"
To set a custom job name, please use [SetBackgroupJobDescription(string name)](https://github.com/Azure/azure-powershell-common/blob/master/src/Common/AzurePSCmdlet.cs#L810). The default job description is: "Long Running Operation for '{cmdlet name}' on resource '{resource name}'"

## Argument Completers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The following prerequisites should be completed before contributing to the Azure

- Install [Visual Studio 2017](https://www.visualstudio.com/downloads/)
- Install the latest version of [Git](https://git-scm.com/downloads)
- Install the [`platyPS` module](https://github.com/Azure/azure-powershell/blob/dev/documentation/development-docs/help-generation.md#installing-platyps)
- Install the [`platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md#installing-platyps)
- Set the PowerShell [execution policy](https://technet.microsoft.com/en-us/library/ee176961.aspx) to **Unrestricted** for the following versions of PowerShell:
- `C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe`
- `C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe`
Expand Down Expand Up @@ -85,10 +85,10 @@ You now be able to create your own branches, commit changes, and push commits to
git remote add upstream https://github.com/Azure/azure-powershell.git
```

Then, to pull changes from the **dev** branch in _Azure/azure-powershell_ into your local working branch, run the following command:
Then, to pull changes from the **master** branch in _Azure/azure-powershell_ into your local working branch, run the following command:

```
git pull upstream dev
git pull upstream master
```

## Building the Environment
Expand Down Expand Up @@ -369,7 +369,7 @@ Create these environment variables for the AD scenario tests:

# After Development

Once all of your cmdlets have been created and the appropriate tests have been added, you can open a pull request in the Azure PowerShell repository to have your cmdlets added to the next release. Please make sure to read [CONTRIBUTING.md](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md) for more information on how to open a pull request, clean up commits, make sure appropriate files have been added/changed, and more.
Once all of your cmdlets have been created and the appropriate tests have been added, you can open a pull request in the Azure PowerShell repository to have your cmdlets added to the next release. Please make sure to read [CONTRIBUTING.md](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md) for more information on how to open a pull request, clean up commits, make sure appropriate files have been added/changed, and more.

# Misc

Expand Down
Loading

0 comments on commit 8e88b85

Please sign in to comment.