mirror of
https://github.com/photonstorm/phaser
synced 2024-11-24 21:53:59 +00:00
simplifies code contributions by fully automating the setup with gitpod.
This commit is contained in:
parent
5a6b274510
commit
266a1b03b7
2 changed files with 27 additions and 0 deletions
14
.github/CONTRIBUTING.md
vendored
14
.github/CONTRIBUTING.md
vendored
|
@ -22,6 +22,20 @@ Before contributing, please read the [code of conduct](https://github.com/photon
|
|||
|
||||
We have a very active [Phaser Support Forum][4]. If you need general support, or are struggling to understand how to do something or need your code checked over, then we would urge you to post it to our forum. There are a lot of friendly devs in there who can help, as well as the core Phaser team, so it's a great place to get support. You're welcome to report bugs directly on GitHub, but for general support we'd always recommend using the forum first.
|
||||
|
||||
## Contribute with online one-click setup
|
||||
|
||||
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click, it will launch a workspace and automatically:
|
||||
|
||||
- clone the `phaser` repo.
|
||||
- install the dependencies.
|
||||
- run `npm run build`.
|
||||
- run `npm run watch`.
|
||||
- clone `phaser-3-examples` and afterwards install dependencies and run `npm start` in there.
|
||||
|
||||
So that anyone interested in contributing can start straight away.
|
||||
|
||||
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/photonstorm/phaser)
|
||||
|
||||
## Making Changes
|
||||
|
||||
I'm assuming you already have a recent version of [Node](https://nodejs.org) installed locally and can run `npm`. This guide is tested and works on both Windows 10 and OS X.
|
||||
|
|
13
.gitpod.yml
Normal file
13
.gitpod.yml
Normal file
|
@ -0,0 +1,13 @@
|
|||
tasks:
|
||||
- init: >
|
||||
npm install &&
|
||||
npm run build
|
||||
command: npm run watch
|
||||
- init: >
|
||||
cd ../ &&
|
||||
git clone https://github.com/photonstorm/phaser3-examples.git &&
|
||||
cd phaser3-examples &&
|
||||
npm install && npm start
|
||||
ports:
|
||||
- port: 8080
|
||||
onOpen: open-preview
|
Loading…
Reference in a new issue