Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PowerShell code not conforming to style guide #1464

Open
3 tasks
schrolla opened this issue Dec 9, 2024 · 1 comment
Open
3 tasks

Update PowerShell code not conforming to style guide #1464

schrolla opened this issue Dec 9, 2024 · 1 comment
Labels
code-review This issue or task involves reviewing the code for the assigned script
Milestone

Comments

@schrolla
Copy link
Collaborator

schrolla commented Dec 9, 2024

💡 Summary

Update existing PowerShell code to apply project rules of style more consistently. While automation checks for many of the rules we have, some are not. In particular, not all powershell includes docstrings for defined functions that allows developers to easily understand what a function does and use Get-Help to bring up function documentation.

Motivation and context

Improved readability and maintainability of the ScubaGear PowerShell code base.

Implementation notes

Please provide details for implementation, such as:

  • Check Posh style guide for style gaps not checked by linter already
  • Review existing Powershell code to ensure all functions have docstrings with synopsis at a minimum
  • Review PowerShell code for other style gaps
  • Note gaps for potential inclusion in linter for the future

Acceptance criteria

How do we know when this work is done?

  • All PowerShell code has been successfully reviewed for adherence to style guide
  • Any deviations from style guide have been corrected or exempted
  • Open issues to add style gaps to linter in the future
@schrolla schrolla added the code-review This issue or task involves reviewing the code for the assigned script label Dec 16, 2024
@schrolla
Copy link
Collaborator Author

schrolla commented Dec 16, 2024

Check to see if existing linters have support to monitor for additional gaps. Look at PSSA MissingCommentHelp rule.

@schrolla schrolla added this to the Marlin milestone Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-review This issue or task involves reviewing the code for the assigned script
Projects
None yet
Development

No branches or pull requests

1 participant