From 46f10004d45315a8d727d0ad7c6f7e38b9a0c995 Mon Sep 17 00:00:00 2001 From: Kate Date: Fri, 17 May 2024 14:22:17 +0100 Subject: [PATCH 1/2] Add a basic CONTRIBUTING.md file --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a7a035b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +### Developement setup + +Requirements: +* nodejs +* corepack (shipped with nodejs, however on some distributions it is not distributed, in which case install it through npm using: `npm install -g corepack`) + +To regenerated the compiled javascript files in `dist/`, call: +``` +corepack enable +yarn build +``` From 5ec1aaaa58c37350e979a373479f22241a9374b5 Mon Sep 17 00:00:00 2001 From: Sora Morimoto Date: Sat, 8 Jun 2024 07:14:34 +0900 Subject: [PATCH 2/2] Update CONTRIBUTING.md Signed-off-by: Sora Morimoto --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7a035b0..ecc640e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,15 @@ ### Developement setup Requirements: -* nodejs -* corepack (shipped with nodejs, however on some distributions it is not distributed, in which case install it through npm using: `npm install -g corepack`) -To regenerated the compiled javascript files in `dist/`, call: +- [Node.js](https://nodejs.org) +- [Corepack](https://nodejs.org/api/corepack.html) + - Shipped with Node.js, however on some distributions it is not distributed, in which case install it through npm using: `npm install --global corepack` + +To regenerated the compiled JavaScript files in `dist/`, call: + ``` corepack enable +yarn install --immutable yarn build ```