From ea7e7fbde288dc0bc8496de12ce0064221e22f86 Mon Sep 17 00:00:00 2001 From: Noam Honig Date: Tue, 3 Sep 2024 09:08:47 +0300 Subject: [PATCH 1/4] Change the clone url the git@github.com didn't work on my machine Also - when trying to set this up, it required the specific pnpm@8.15.6 for some reason - so I've added that to the document --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 27323a58b..b9fccb2a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,14 +4,14 @@ Hi! We are really excited that you are interested in contributing to TutorialKit ## Repo Setup -The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). +The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). pnpm version 8.15.6 is required (npm i -g pnpm@8.15.6) To develop and test packages: 1. Clone this repository and navigate into the cloned directory. ``` -git clone git@github.com:stackblitz/tutorialkit.git +git clone https://github.com/stackblitz/tutorialkit cd tutorialkit ``` From 4f737dd5d2901cfc01b338c61d8f00602cc94712 Mon Sep 17 00:00:00 2001 From: Noam Honig Date: Tue, 3 Sep 2024 09:59:34 +0300 Subject: [PATCH 2/4] Added a reference to package manager MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ari Perkkiö --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9fccb2a7..0756ed8e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Hi! We are really excited that you are interested in contributing to TutorialKit ## Repo Setup -The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). pnpm version 8.15.6 is required (npm i -g pnpm@8.15.6) +The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). Package manager versioning is handled by [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) field that's supported by [Node's Corepack](https://nodejs.org/api/corepack.html) and other tools. To develop and test packages: From fe5f0095a4f08713bc5cdb0dcfdc88ffcb9fab74 Mon Sep 17 00:00:00 2001 From: Noam Honig Date: Tue, 3 Sep 2024 10:00:35 +0300 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0756ed8e6..4411311d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Hi! We are really excited that you are interested in contributing to TutorialKit ## Repo Setup -The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). Package manager versioning is handled by [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) field that's supported by [Node's Corepack](https://nodejs.org/api/corepack.html) and other tools. +The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). Package manager versioning is handled by [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) field that's supported by [Node's Corepack](https://nodejs.org/api/corepack.html) and other tools. You can find the specific pnpm version required at: https://github.com/stackblitz/tutorialkit/blob/main/package.json#L23 To develop and test packages: From f5288ae2ddb98bef6eb5354d64f5697eda5962a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ari=20Perkki=C3=B6?= Date: Tue, 3 Sep 2024 13:34:05 +0300 Subject: [PATCH 4/4] docs: remove packagge.json link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4411311d1..0756ed8e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Hi! We are really excited that you are interested in contributing to TutorialKit ## Repo Setup -The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). Package manager versioning is handled by [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) field that's supported by [Node's Corepack](https://nodejs.org/api/corepack.html) and other tools. You can find the specific pnpm version required at: https://github.com/stackblitz/tutorialkit/blob/main/package.json#L23 +The TutorialKit repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). Package manager versioning is handled by [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) field that's supported by [Node's Corepack](https://nodejs.org/api/corepack.html) and other tools. To develop and test packages: