-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: initial contribution guide (#531)
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |