Skip to content

Commit 76ae461

Browse files
committed
chore: add CONTRIBUTING.md
1 parent 0801a8d commit 76ae461

2 files changed

Lines changed: 19 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contributing to KAPLAYGROUND
2+
3+
We are currently working on `new-editor` branch, please don't make any changes
4+
to `master` branch.
5+
6+
## Setup environment
7+
8+
```
9+
git clone https://github.com/kaplayjs/kaplayground.git
10+
cd kaplayground
11+
pnpm i # will install and setup stuff of submodules
12+
pnpm dev # will start the development server
13+
pnpm fmt # before commit
14+
```
15+
16+
## Commit messages
17+
18+
Follow the KAPLAY repo [conventional commits guidelines.](https://github.com/kaplayjs/kaplay/blob/master/CONTRIBUTING.md#conventional-commits-guide)

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@
33
"type": "module",
44
"version": "2.0.0",
55
"scripts": {
6+
"install": "git submodule update --init --recursive && cd kaplay && pnpm i",
67
"dev": "vite dev",
78
"start": "vite dev",
89
"build": "vite build",
910
"preview": "vite preview",
1011
"generate:examples": "node --experimental-strip-types scripts/examples.ts",
1112
"fmt": "dprint fmt",
12-
"fk": "cd kaplay && pnpm i && pnpm build && cd .. && pnpm copy",
13-
"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",
1413
"check": "tsc --noEmit"
1514
},
1615
"dependencies": {

0 commit comments

Comments
 (0)