Code Review Guidelines

%3CLINGO-SUB%20id%3D%22lingo-sub-65972%22%20slang%3D%22en-US%22%3ECode%20Review%20Guidelines%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-65972%22%20slang%3D%22en-US%22%3E%3CP%3EHello%20everyone%2C%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EAre%20you%20using%20code%20review%20in%20your%20team%20%3F%26nbsp%3B(i%20do%20but%20still%20got%20a%20lot%20of%20questions)%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3E*%26nbsp%3BDo%20you%20use%20a%20guideline%3F%26nbsp%3Blike%20this%20%3CA%20href%3D%22https%3A%2F%2Fwww.reddit.com%2Fr%2FPowerShell%2Fcomments%2F4dauu1%2Fpowershell_code_review_guidelines%2F%22%20target%3D%22_blank%22%20rel%3D%22nofollow%20noopener%20noreferrer%22%3Eone%3C%2FA%3E%26nbsp%3B(by%26nbsp%3B%3CSPAN%3EMike%20Shepard%3C%2FSPAN%3E)%3F%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3E*%20Do%20you%20use%26nbsp%3BPowerShell%2F%3CA%20href%3D%22https%3A%2F%2Fgithub.com%2FPowerShell%2FPSScriptAnalyzer%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EPSScriptAnalyzer%3C%2FA%3E%26nbsp%3Bin%20your%20code%20review%3F%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3E*%20What's%20your%20process%20if%20you%20have%20one%3F%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EThanks%2C%3C%2FP%3E%3CP%3EArnaud%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-LABS%20id%3D%22lingo-labs-65972%22%20slang%3D%22en-US%22%3E%3CLINGO-LABEL%3EPowerShell%3C%2FLINGO-LABEL%3E%3C%2FLINGO-LABS%3E%3CLINGO-SUB%20id%3D%22lingo-sub-86958%22%20slang%3D%22en-US%22%3ERe%3A%20Code%20Review%20Guidelines%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-86958%22%20slang%3D%22en-US%22%3E%3CP%3EWe%20use%20PSScriptAnalyser%20with%20custom%20rules%20and%20Pester%20Unit%20tests.%20On%20commit%20to%20GIT%20we%20check%20that%20Test%20are%20good%20and%20Code%20Coverage%20is%20high.%20Check%20out%20any%20of%20Microsoft%20DSC%20Resource%20GIT%20Repos%20to%20see%20how%20they%20use%20appveyor%20and%20codecov.%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-67358%22%20slang%3D%22en-US%22%3ERE%3A%20Code%20Review%20Guidelines%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-67358%22%20slang%3D%22en-US%22%3EWell%20I'm%20a%20Steroids%20user%20so%20I%20get%20that%20taken%20care%20of.%20But%20I%20agree%20with%20Mike%20Shepard%20that%20scripts%20that%20are%20anything%20but%20private%20should%20maintain%20a%20high%20level%20of%20readability%20and%20be%20very%20robust.%3C%2FLINGO-BODY%3E
Occasional Contributor

Hello everyone,

 

Are you using code review in your team ? (i do but still got a lot of questions)

 

* Do you use a guideline? like this one (by Mike Shepard)?

 

* Do you use PowerShell/PSScriptAnalyzer in your code review?

 

* What's your process if you have one?

 

Thanks,

Arnaud

2 Replies
Well I'm a Steroids user so I get that taken care of. But I agree with Mike Shepard that scripts that are anything but private should maintain a high level of readability and be very robust.

We use PSScriptAnalyser with custom rules and Pester Unit tests. On commit to GIT we check that Test are good and Code Coverage is high. Check out any of Microsoft DSC Resource GIT Repos to see how they use appveyor and codecov.