Skip to content

Commit

Permalink
chore: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lajbel committed Sep 26, 2024
1 parent 0801a8d commit 76ae461
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down

0 comments on commit 76ae461

Please sign in to comment.