docs icon indicating copy to clipboard operation
docs copied to clipboard

PowerShell examples does not follow best practices

Open bjompen opened this issue 2 years ago • 5 comments

Code of Conduct

What article on docs.github.com is affected?

content/actions/using-workflows/workflow-commands-for-github-actions.md

What part(s) of the article would you like to see updated?

PowerShell / pwsh examples does not follow best practices on a number of things on how to write good PowerShell code. Some examples are

  • Stream redirects (>>) instead of using commands ( | Out-File )
  • Aliases used in code (for example rm -> Remove-Item and set -> Set-Variable)
  • Positional parameters instead of named

This makes them not only harder to read and understand, but also leads to decreased code quality and increased risk of unexpected behaviours.

Additional information

No response

bjompen avatar Apr 05 '23 08:04 bjompen

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Apr 05 '23 08:04 welcome[bot]

@bjompen Thanks for opening an issue and submitting a PR! ✨

cmwilson21 avatar Apr 05 '23 19:04 cmwilson21

A stale label has been added to this issue becuase it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.

github-actions[bot] avatar Jun 05 '23 16:06 github-actions[bot]

Yes ok

hosein6666 avatar Jun 06 '23 17:06 hosein6666

-pull-request-reviews.md

hosein6666 avatar Jun 06 '23 17:06 hosein6666

A stale label has been added to this issue because it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.

github-actions[bot] avatar Aug 07 '23 16:08 github-actions[bot]