Contributing

July 9, 2021 ยท View on GitHub

Contributions welcome!

Setup development environment

  1. Install asdf tools 
    asdf plugin add shellcheck https://github.com/luizm/asdf-shellcheck.git
asdf plugin add shfmt https://github.com/luizm/asdf-shfmt.git
asdf install
  2. Develop!
  3. Lint & Format 
    ./scripts/shellcheck.bash
./scripts/shfmt.bash
  4. PR changes

Testing Locally

asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]

#
asdf plugin test make https://github.com/yacchi/asdf-make.git "make --version"

Tests are automatically run in GitHub Actions on push and PR.