From 76ae4611faa9360065ba69f453bc8d3d9413941e Mon Sep 17 00:00:00 2001 From: lajbel Date: Thu, 26 Sep 2024 09:00:55 -0300 Subject: [PATCH] chore: add CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ package.json | 3 +-- 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..78880d0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing to KAPLAYGROUND + +We are currently working on `new-editor` branch, please don't make any changes +to `master` branch. + +## Setup environment + +``` +git clone https://github.com/kaplayjs/kaplayground.git +cd kaplayground +pnpm i # will install and setup stuff of submodules +pnpm dev # will start the development server +pnpm fmt # before commit +``` + +## Commit messages + +Follow the KAPLAY repo [conventional commits guidelines.](https://github.com/kaplayjs/kaplay/blob/master/CONTRIBUTING.md#conventional-commits-guide) diff --git a/package.json b/package.json index 7d9c86d..aaa97b0 100644 --- a/package.json +++ b/package.json @@ -3,14 +3,13 @@ "type": "module", "version": "2.0.0", "scripts": { + "install": "git submodule update --init --recursive && cd kaplay && pnpm i", "dev": "vite dev", "start": "vite dev", "build": "vite build", "preview": "vite preview", "generate:examples": "node --experimental-strip-types scripts/examples.ts", "fmt": "dprint fmt", - "fk": "cd kaplay && pnpm i && pnpm build && cd .. && pnpm copy", - "copy": "cp -r kaplay/assets/sprites kaplay/dist/kaboom.js kaplay/dist/kaboom.js.map public/ && cp -r kaplay/examples/sprites kaplay/examples/fonts kaplay/examples/sounds kaplay/examples/shaders public/examples", "check": "tsc --noEmit" }, "dependencies": {