Skip to content

Commit

Permalink
docs: add node installation details to contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cameronhunter committed Apr 13, 2024
1 parent 2643900 commit 74c989b
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,19 @@ This project adheres to the American Express [Code of Conduct](./CODE_OF_CONDUCT

> replace `your-github-username` with your github username

3. Install the dependencies by running
3. Install and use the correct version of node (specified in `.nvmrc`)

```bash
$ nvm use
```

4. Install the dependencies by running

```bash
$ npm install
```

4. You can now run any of these scripts from the root folder.
5. You can now run any of these scripts from the root folder.

#### Running tests

Expand Down Expand Up @@ -112,4 +118,4 @@ Please review our [Security Policy](./SECURITY.md). Please follow the instructio
### Git Commit Guidelines
We follow [conventional commits](https://www.conventionalcommits.org/) for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.
We follow [conventional commits](https://www.conventionalcommits.org/) for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.

0 comments on commit 74c989b

Please sign in to comment.