Skip to content

Commit

Permalink
docs: include build and bun steps
Browse files Browse the repository at this point in the history
  • Loading branch information
wellwelwel committed May 17, 2024
1 parent 89b4859 commit 55dfb88
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ We can discuss design of API and implementation ideas.
### General (recommended)

```sh
npm run test
npm run test # Test with the installed Node.js version
npm run test:bun # Test with the installed Bun version
```

### Coverage
Expand All @@ -56,17 +57,25 @@ npm run test:c8
> ⚠️ Testing using **Docker** can require a considerable local storage.
```sh
npm run test:ci:node
npm run test:ci:bun
npm run test:ci:deno
npm run build # Build the Project
```

```sh
npm run test:ci:node # All Node.js versions from 6+
npm run test:ci:bun # All Bun versions from 1+
npm run test:ci:deno # All Deno versions from 1+
```

- You may prefer to use **GitHub Actions** for compatibility testing.

### Compatibility (All — Docker)
### Compatibility (All Platforms — Docker)

> ⚠️ Slow and heavy
```sh
npm run build # Build the Project
```

```sh
npm run test:ci
```
Expand Down

0 comments on commit 55dfb88

Please sign in to comment.