From a5e15da5b712f62863ae7fe6c18f43b7ebf66535 Mon Sep 17 00:00:00 2001 From: Niklas Gruhn Date: Mon, 7 Aug 2023 20:03:28 +0200 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18342082..32ddc4c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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). -