Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.02 KB

Contributing

asdf is used to manage the development tools for these GitHub Actions. See its documentation to install and setup on your machine.

Setup

# add plugins with asdf (plugin source URLs correspond to the defaults provided by the asdf plugin repository)
asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
asdf plugin add pnpm https://github.com/jonathanmorley/asdf-pnpm.git
asdf plugin add lefthook https://github.com/jtzero/asdf-lefthook.git
# install tools
asdf install
# install nodejs deps & setup lefthook
pnpm install

GitHub Actions

Contributions are welcome. Please raise an issue to discuss changes before raising a Pull Request.

Source code for the Actions can be found in the src/ directory.

Code Quality

Lefthook is used to run pre-commit and pre-push Git Hooks to ensure standard practices are followed before raising code changes in Pull Requests. It will be installed and configured by the above steps.