Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: initial contribution guide #531

Merged
merged 1 commit into from
Mar 14, 2023
Merged

docs: initial contribution guide #531

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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.