.github

Required software

• commitizen: Enforces the usage of the Commitizen commit message format for consistent and standardized commits
  • Installation
    • macOS - via Homebrew: brew install commitizen
    • Windows: Install via pipx, then follow developer instructions
• pre-commit: A framework for managing and maintaining multi-language pre-commit hooks.
  • Installation
    • Install via pip: pip install pre-commit
• shellcheck: ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts
  • Installation
    • macOS:
      • via Homebrew: brew install shellcheck
      • via MacPorts: sudo port install shellcheck
    • Windows:
      • via Chocolatey: C:\> choco install shellcheck
      • via Scoop: C:\> scoop install shellcheck
      • via winget: C:\> winget install --id koalaman.shellcheck
    • Docker: docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable myscript
      • Or replace stable with :v0.4.7 for that version, or :latest for daily builds, etc.

macOS users can install all software by executing the macos script under the install directory. From the repository root:

./install/macos