Skip to content

Commit 266a1b0

Browse files
committed
simplifies code contributions by fully automating the setup with gitpod.
1 parent 5a6b274 commit 266a1b0

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

.github/CONTRIBUTING.md

+14
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,20 @@ Before contributing, please read the [code of conduct](https://github.com/photon
2222

2323
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.
2424

25+
## Contribute with online one-click setup
26+
27+
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click, it will launch a workspace and automatically:
28+
29+
- clone the `phaser` repo.
30+
- install the dependencies.
31+
- run `npm run build`.
32+
- run `npm run watch`.
33+
- clone `phaser-3-examples` and afterwards install dependencies and run `npm start` in there.
34+
35+
So that anyone interested in contributing can start straight away.
36+
37+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/photonstorm/phaser)
38+
2539
## Making Changes
2640

2741
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.

.gitpod.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
tasks:
2+
- init: >
3+
npm install &&
4+
npm run build
5+
command: npm run watch
6+
- init: >
7+
cd ../ &&
8+
git clone https://github.com/photonstorm/phaser3-examples.git &&
9+
cd phaser3-examples &&
10+
npm install && npm start
11+
ports:
12+
- port: 8080
13+
onOpen: open-preview

0 commit comments

Comments
 (0)