voltron/PowerCLI-Example-Scripts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #8 from vmware/Reorg

Browse Source 
Readme Updates
This commit is contained in:
Kyle Ruddy
2016-07-15 15:00:11 -07:00
committed by GitHub
parent 4464bf001b e6744ea742
commit eae378822b
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -53,11 +53,13 @@ The following information must be included with each submitted scripting resourc
* Minimal/High Level Description * Minimal/High Level Description
* What does the resource do * What does the resource do
* Any KNOWN limitations or dependencies * Any KNOWN limitations or dependencies
* vSphere version, required modules, etc. * vSphere version, required modules, etc.
**Note Placement Examples:**
#### Note Placement Examples:
Script: Top few lines Script: Top few lines
Module: Module manifest Module: Module manifest
**Script Note Example:**
#### Script Note Example:
<# <#
Script name: script_name.ps1 Script name: script_name.ps1
Created on: 07/07/2016 Created on: 07/07/2016
@@ -73,6 +75,7 @@ The following information should be included when possible. Inclusion of informa
* PowerShell version against which the script was developed/tested * PowerShell version against which the script was developed/tested
* OS platform version against which the script was tested/developed * OS platform version against which the script was tested/developed
* Keywords that make it easier to find a script, for example: VDS, health check * Keywords that make it easier to find a script, for example: VDS, health check
## Suggested Quality Management ## Suggested Quality Management
This section describes guidelines put in place to maintain a standard of quality while also promoting broader contribution. This section describes guidelines put in place to maintain a standard of quality while also promoting broader contribution.
### General Best Practices ### General Best Practices