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

Merge pull request #9 from vmware/Reorg

Browse Source 
Readme Updates
This commit is contained in:
Kyle Ruddy
2016-07-15 15:02:35 -07:00
committed by GitHub
parent eae378822b fd3c02b434
commit c8b2607b94
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -80,24 +80,32 @@ The following information should be included when possible. Inclusion of informa
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
### Resource Naming ### Resource Naming
* Give the resource a name that is indicitive of the actions and/or results of its running * Give the resource a name that is indicitive of the actions and/or results of its running
### Fault Handling ### Fault Handling
* Every submitted resource should include basic fault handling. One of many good write-ups can be found via Microsoft’s Hey, Scripting Guy! Blog: https://blogs.technet.microsoft.com/heyscriptingguy/2014/07/09/handling-errors-the-powershell-way/ * Every submitted resource should include basic fault handling. One of many good write-ups can be found via Microsoft’s Hey, Scripting Guy! Blog: https://blogs.technet.microsoft.com/heyscriptingguy/2014/07/09/handling-errors-the-powershell-way/
### Alias Usage ### Alias Usage
* Avoid any alias usage within all submitted resources. * Avoid any alias usage within all submitted resources.
### Global Variable Usage ### Global Variable Usage
* Avoid changing any global variables * Avoid changing any global variables
### Help Information ### Help Information
* All resources shall have inline documentation. * All resources shall have inline documentation.
### Scripts ### Scripts
* The script should be easy to read and understand * The script should be easy to read and understand
* Place user-defined variables towards the top of the script * Place user-defined variables towards the top of the script
### Modules ### Modules
* The module file, PSM1, should contain only functions. A module manifest file, PSD1, should also be created and included. A module formatting file (format.ps1xml) is desirable but not a requirement. * The module file, PSM1, should contain only functions. A module manifest file, PSD1, should also be created and included. A module formatting file (format.ps1xml) is desirable but not a requirement.
* Use only standard verbs * Use only standard verbs
### Security ### Security
* Usage of PowerShell’s strict mode is preferred, but not required. * Usage of PowerShell’s strict mode is preferred, but not required.
* Remove any information related to one’s own environment (examples: Passwords, DNS/IP Addresses, custom user credentials, etc) * Remove any information related to one’s own environment (examples: Passwords, DNS/IP Addresses, custom user credentials, etc)
## Resource Maintenance ## Resource Maintenance
### Maintenance Ownership ### Maintenance Ownership
Ownership of any and all submitted resources are maintained by the submitter. This ownership also includes maintenance of any and all submitted resources. Ownership of any and all submitted resources are maintained by the submitter. This ownership also includes maintenance of any and all submitted resources.