Skip to content

Commit

Permalink
docs: Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rcdailey committed Dec 26, 2023
1 parent 3e087f6 commit 31d0476
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing

## Node Installation

1. Install Node Version Manager (nvm) using the instructions [here][node]. Note: On Windows, it is
recommended to use "NVM for Windows". You can install this with Winget or Chocolatey.
1. Install Node v21 using `nvm install 21`.
1. Run `nvm use 21` to change your current version of node.

[node]: https://github.com/nvm-sh/nvm#installing-and-updating

## Yarn & Package Installation

After Node is installed, you must install Yarn. These instructions were taken from [here][yarn].

1. Install yarn using the command `corepack enable`.
1. Then run `yarn install` to install all dependencies.

[yarn]: https://yarnpkg.com/getting-started/install

## Update Distribution

The `dist` directory contains the published version of the github action. When a change is made, the
distribution must be updated.

1. Delete the current `dist` directory with `rm -rf dist`.
1. Regenerate the distribution with `yarn build`.
1. Commit all changes to the `dist` directory.

0 comments on commit 31d0476

Please sign in to comment.