Skip to content

Commit

Permalink
Add development documentation (#64)
Browse files Browse the repository at this point in the history
  • Loading branch information
devpow112 authored Jan 24, 2024
1 parent 68a81bb commit e266aaa
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,47 @@
> [!WARNING]
> This is still a work in progress. Any usage of this package is subject to
> change without notice.
## Developing

After cloning the repository make sure to install dependencies.

```console
npm ci
```

### Linting

```console
# currently only eslint
npm run lint

# eslint only
npm run lint:eslint
```

### Formatting

```console
# currently only eslint
npm run fix

# eslint only
npm run fix:eslint
```

### Testing

```console
# lint, unit tests and integration tests
npm test

# unit tests and integration tests only
npm run test:all

# unit tests only
npm run test:unit

# integration tests only
npm run test:integration
```

0 comments on commit e266aaa

Please sign in to comment.