Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.32 KB

File metadata and controls

42 lines (29 loc) · 1.32 KB

Contributing to KAPLAYGROUND

Thanks for your interest in contributing with the KAPLAYGROUND repo. Through this document you will see important information for contributing in the repository.

Pre-requisites

Conventions

Branches

  • dev: The branch with non-released changes and features in development, it is the branch you checkout to develop your features. It is the default branch.
  • master: The deployment branch, this branch reflects what you can see in https://play.kaplayjs.com.

So what branch should I use for developing features and then creating PR? dev.

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

Merge dev with master workflow

If you have access to deployments and you need to merge changes in dev to master, so deployment is updated, you must follow this special workflow:

git checkout dev
git merge master
git checkout master
git merge --ff-only dev