extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-04-30 05:34:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Markus Fleschutz 2021-02-09 19:37:26 +01:00
parent f7eca6274c
commit 13a8e29837
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -171,16 +171,17 @@ Using PowerShell in Context Menus
Script Conventions
------------------
Each PowerShell script should follow the 8 golden rules:
Each PowerShell script should follow the 9 golden rules:
1. the filename should be named `<verb>-<object>.ps1`
2. the first line reads `#!/bin/powershell` to support PowerShell on Linux
3. the script has execute file permissions (chmod a+rx <file>) to support PowerShell on Linux
4. provide a comment-based help with syntax, description, link, author, and license
5. prefer command-line options, else ask the user
6. use `Set-StrictMode -Version Latest` to enable additional error checking
7. for readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else
8. exit 0 for success, else print an error message and exit with the error code (mostly 1)
5. check the requirements (e.g. #Requires -RunAsAdministrator, or #Requires -Version 3)
6. prefer command-line options, else ask the user
7. use `Set-StrictMode -Version Latest` to enable additional error checking
8. for readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else
9. exit 0 for success, else print an error message and exit with the error code (mostly 1)
Feedback
--------