Glossary
- Generic Pull Request review activities
- Review Markdown documentation
- Review ARM Templates
- Review Powershell
- Review C# Code
- Review Angular JS or TS
Pull Request Review activities
When a Pull Request needs to be reviewed follow the activities described on this page and your common sense.
Investigate the work
Look and understand the trail of work, look at the linked tasks and the related product backlog items and features. Including other tasks.
It is important to understand the context of the pull request.
View the Build and test results
Most branches have a build policy for changes, look at the build, if it succeeds if tests are run and the length of the build. Did it increase a lot?
Get the Branch and run it local
When possible, pull the Pull Request local and run it. It should run.
Look if the task is complete
Does it has documentation are tests written no typos proper coding standards.
for documentation run jekyll and validate
- bundle exec jekyll serve
- run cspell
- read the text and decide if it is meaningful and minimal
for arm templates
- look if there is a build and release for it, and if they are working.
- validate the readme.md which belongs to the arm template
- is it in sync, all parameters there and can you understand it
- validate the template in the azure portal. got to azure portal got cloud boost resource group add resource select template and add the template validate the deployment via deployment in the resource group
for powershell
Log in to your Azure account Create a resource group that serves as the container for the deployed resources. The name of the resource group can only include alphanumeric characters, periods, underscores, hyphens, and parenthesis. It can be up to 90 characters. It cannot end in a period. Deploy to the resource group the template that defines the resources to create
A template can include parameters that enable you to customize the deployment. For example, you can provide values that are tailored for a particular environment (such as dev, test, and production). The sample template defines a parameter for the storage account SKU. The following example creates a resource group, and deploys a template from your local machine:
Copy Connect-AzureRmAccount
Select-AzureRmSubscription -SubscriptionName
New-AzureRmResourceGroup -Name ExampleResourceGroup -Location “South Central US” New-AzureRmResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup ` -TemplateFile c:\MyTemplates\storage.json -storageAccountType Standard_GRS The deployment can take a few minutes to complete. When it finishes, you see a message that includes the result:
Copy ProvisioningState : Succeeded Deploy a template from an external source Instead of storing Resource Manager templates on your local machine, you may prefer to store them in an external location. You can store templates in a source control repository (such as GitHub). Or, you can store them in an Azure storage account for shared access in your organization.
To deploy an external template, use the TemplateUri parameter. Use the URI in the example to deploy the sample template from GitHub.
PowerShell
Copy New-AzureRmResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup ` -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-storage-account-create/azuredeploy.json ` -storageAccountType Standard_GRS