Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
meili-bot committed Jun 1, 2022
1 parent 4c4ffb5 commit 27bb22a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ To run this project, you will need:

### Setup

You can set up your local environment natively or using `docker`, check out the [`docker-compose.yml`](/docker-compose.yml).

Example of running all the checks with docker:
```bash
docker-compose run --rm package bash -c "list of the commands required to build + run tests + run linters"
```

To install dependencies:


```bash
yarn --dev
```
Expand Down

0 comments on commit 27bb22a

Please sign in to comment.