Best Practices | 2024 Change suggestions

PoshCode / PowerShellPracticeAndStyle

The Unofficial PowerShell Best Practices and Style Guide

Other

2.2k stars 289 forks source link

General ideas

[ ] Change all code names for each rule to BPR-01 or BEST-01 or BESTPRACTICES-01 or RULE-01 and keep consistent. Change and replace should be easy

[ ] avoid different code names for the prefix conventions

[ ] Perhaps a dictionary of terms used in the guide is needed

[ ] Possibly a beginner, intermediate and advanced level breakdown so we can tailor content to each different audience

[ ] Introduction / Summary...?

Specific tool / rule changes

[ ] TOOL-01 Decide whether you're coding a 'tool' or a 'controller' script: Shortin it and maybe a table format

[ ] TOOL-02 Make your code modular: Concept solid, just make it one line

[ ] TOOL-03 Make tools as re-usable as possible

[ ] makes the same point as 02. Delete?

[x] TOOL-04 Use PowerShell standard cmdlet naming

[x] TOOL-05 Use PowerShell standard parameter naming TOOL-06 Tools should output raw data

[ ] Valid. Shorten a little, maybe merge 06 & 07

[x] TOOL-07 Controllers should typically output formatted data:

[ ] WAST-01 Don't re-invent the wheel: Valid but too much to read for a best practices guide. List the practices, max 3 lines to explain, get out

[ ] WAST-02 Report bugs to Microsoft: Yes but move to a more appropriate place

[ ] PURE01: Either this or PURE-03 as number one

[ ] PURE-03 Document why you haven't used PowerShell | Promote this to number one, this is excellent.

[ ] PURE04: Move this to an advanced user section

Building-Reusable-Tools.md

General ideas

[ ] Change all code names for each rule to BPR-01 or BEST-01 or BESTPRACTICES-01 or RULE-01 and keep consistent. Change and replace should be easy
[ ] avoid different code names for the prefix conventions
[ ] Perhaps a dictionary of terms used in the guide is needed
[ ] Possibly a beginner, intermediate and advanced level breakdown so we can tailor content to each different audience

Specific tool / rule changes

TOOL-01 Decide whether you're coding a 'tool' or a 'controller' script

[ ] Shorten / reformat

TOOL-02 Make your code modular

[ ] Concept solid, just make it one line

TOOL-03 Make tools as re-usable as possible

[ ] makes the same point as 02. Delete?

TOOL-04 Use PowerShell standard cmdlet naming

[x] No action

TOOL-05 Use PowerShell standard parameter naming

[x] No action

TOOL-06 Tools should output raw data

[ ] Valid. Shorten a little, maybe merge 06 & 07

TOOL-07 Controllers should typically output formatted data

[x] No action

WAST-01 Don't re-invent the wheel

[ ] Valid but too much to read for a best practices guide. List the practices, max 3 lines to explain, get out

WAST-02 Report bugs to Microsoft PURE-01 Use native PowerShell where possible

[ ] Either this or PURE-03 as number one

PURE-03 Document why you haven't used PowerShell

[ ] Promote this to number one, this is excellent.

PURE-04 Wrap other tools in an advanced function or cmdlet

[ ] Maybe an advanced user section

PoshCode / PowerShellPracticeAndStyle