Microsoft.AVS.Management/CONTRIBUTING.md

1.1 KiB

This article is not a detailed guide on how to create a pull request (PR). See here to learn more about how to work with pull requests on GitHub.

The purpose of this article is to illustrate the main checklists you must go through before a PR will be considered for inclusion in Microsoft.AVS.Management.

These are the following checks we'll normally put in place:

  1. Accept contributor agreement
  2. Create an issue Except for small changes, alwats create an issue 1st to discuss the propsal before opening a PR.
  3. Create Documentation Every new function must have standard PowerShell documentation. If you modify a function and add a parameter, it must have associated documentation markup.
  4. Adhere to PowerShell style guidelines and AVS Scripting guidelines Format and test your code.
  5. Do NOT modify repository policies