Skip to content

Commit

Permalink
docs: initial contribution guide (#531)
Browse files Browse the repository at this point in the history
  • Loading branch information
jthegedus committed Mar 14, 2023
1 parent dfb51f8 commit 81d09b9
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

[asdf](https://asdf-vm.com) is used to manage the development tools for these
GitHub Actions. See it's documentation to install and setup on your machine.

## Setup

```shell
# add plugins with asdf
asdf plugin add nodejs
asdf plugin add yarn
asdf plugin add lefthook
# install tools
asdf install
# install nodejs deps & setup lefthook
yarn 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 `lib/` directory.

## Code Quality

[Lefthook](https://github.com/evilmartians/lefthook) is used to run `pre-commit`
and `pre-push` git hooks to ensure standardised best practices are followed
before raising code changes in Pull Requests. It will be installed and
configured by the above steps.

0 comments on commit 81d09b9

Please sign in to comment.