Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (25 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.61 KB

Contribution

Thanks for considering contributing to this project! We are really glad you are reading this, because we need volunteer developers to help this project come to fruition.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Issues

If you find any bugs, please file an issue in the GitHub issues page. Please fill out the provided template with the appropriate information.

If you are taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

Conventions

  • PowerShell (target 7+): start new scripts from PowerShell/_Template.ps1. Use comment-based help, [CmdletBinding()], approved verbs, parameter validation, and SupportsShouldProcess for state-changing operations. Log via Write-Log.psm1. Never hardcode tokens, subscription IDs, or account names; take them as parameters ([securestring] for secrets).
  • Bash: start from Bash/_Template.sh; use set -euo pipefail, quote expansions, and source Bash/log.sh for output.
  • Linting: PowerShell is checked by PSScriptAnalyzer against PSScriptAnalyzerSettings.psd1; Bash by ShellCheck; everything by Super-Linter, on push and pull request. Run Invoke-ScriptAnalyzer with the settings file and shellcheck -x locally before opening a PR.