Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gruhn committed Aug 7, 2023
1 parent 493d4ba commit a5e15da
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ Don't hesitate to open an issue if you have trouble.

### Setup Dev Environment

Canonically this package uses Node 18 and `pnpm` as a package manager.
If you are a [Nix](https://nixos.org/) user, there is a `shell.nix` file in the project root.

Clone the repository and run

```
npm install
pnpm install
```

We use a locally served version of the [demo page](https://vue-qrcode-reader.netlify.app/) during development.
Expand All @@ -20,4 +23,3 @@ npm run docs:dev

The version number of releases is automatically determined form commit messages.
This only works if we follow [Angular Commit Message Conventions](https://github.com/semantic-release/semantic-release#commit-message-format).

0 comments on commit a5e15da

Please sign in to comment.