Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 4 KB

how-to-contirbute.md

File metadata and controls

65 lines (47 loc) · 4 KB
Raw

Azure PaaS Developer - Code Repository Contribution Process

This is a Open Source Platform meant to EMPOWER and ENABLE engineers from Azure PaaS Developer team by sharing their knowledge. The engineers from Azure PaaS Developer team will be publishing the code samples and sample scripts to this repository. This repository primarily contains the sample code for How-To scenarios, proof of concepts and PowerShell scripts for the below technologies:

  • azure-api-management
  • azure-cloud-services
  • azure-policy
  • azure-search
  • azure-arm
  • azure-arm-templates
  • azure-blockchain
  • azure-batch
  • azure-storage
  • azure-redis-cache
  • azure-service-bus
  • azure-service-fabric
  • azure-notificationhub
  • azure-eventhub
  • azure-event-grid
  • azure-relay

How can I contribute ?

  1. Create a profile in GitHub
  2. Login to GitHub with your account, Navigate to the Code Repository in GitHub
  3. Create your own fork and contribute your changes in this fork.
  4. Create PULL Requests of your contributions to Code Repository for review.
  5. The CORE Team admins will review your PULL requests and merge it. They may also propose changes depending on the content.

Guidelines of Code Repository

  • The content must be FRESH and relevant to the technology which is still in support lifecycle.

  • Don’t copy the contents / snippets from any other GitHub / third party articles.

  • Mention the relevant reference article / code changes while you create PULL requests.

  • Follow coding best practices to make it easy for the developers to understand the code / script.

  • Refer these language specific best practices:

    C#

    PowerShell

    Python

    Java

    NodeJS

Please provide brief description about the scripts/code snippets and add relevant comments wherever applicable. If there are any pre-requisites or dependencies needed for the code to run, please mention the same. Avoid committing entire solution/project for a single program/file. Strictly follow proper file naming conventions and add file extension to make it search friendly for other engineers and customers:

  • C# (DotNet): FileName.cs

  • PowerShell: ScriptFile.ps1

  • NodeJS: scriptfile.js or scriptfile.ts

  • Python: python.py or python_script.py

  • Java: FileName.java

Code is read much more often than it is written. The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of our repository.

Most importantly don’t forget to add the “DISCLAIMER” note at top of your script/code snippets. You can use the one suggested below:

Disclaimer

The sample scripts are not supported under any Microsoft standard support program or service. This is intended to be used in non-production enviornment only. The sample scripts are provided AS IS without warranty of any kind. Microsoft further disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The entire risk arising out of the use or performance of the sample scripts and documentation remains with you. In no event shall Microsoft, its authors, owners of this github repro, or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the sample scripts or documentation, even if Microsoft has been advised of the possibility of such damages.