search

PowerShell / DscResources

Central repository for PowerShell Desired State Configuration (DSC) resources.
http://blogs.msdn.com/b/powershell/
MIT License
777 stars 205 forks source link

Rename Best Practices section in StyleGuidelines.MD #447

Closed PlagueHO closed 6 years ago

PlagueHO commented 6 years ago

The Best Practices section in StyleGuidelines.md should be split into two parts:

This will align better with the BestPractices.md.

Also, 'Named Parameters Instead of Positional Parameters' and 'No Cmdlet Aliases' appear as both a best practice and styleguidelines. IMHO it should only appear in the StyleGuidelines as the StyleGuidelines aren't optional.

What do you think @johlju? I'm happy to submit a PR.

johlju commented 6 years ago

Agree to all. I saw "Best Practices" right before looking at this issue, and thought as you, that it couldn't be named best practice in the style guideline. I think it's and old inheritance before the BestPractices.md was created. Please send in a PR. 😃

johlju commented 6 years ago

A thought, it's hard to search in two documents (StyleGuideline.md and BestPractices.md) would it be a bad idea to move BestPractices.md into StyleGuideline.md as a entire new section, and mention at the top of the document that the style guideline section is not optional, and to get to HQRM the best practices should also be followed? No need to do it as part of this issue, but thought I raised the question. My goal is to minimize the documents to read (and link to). Maybe there is a better option?

PlagueHO commented 6 years ago

@johlju - definitely agree. I have many times had to hunt through both files - combining them would be great. I'll raise a separate issue to track this.

PlagueHO commented 6 years ago

Also I'll send the PR for this one too.