From 266a1b03b79c3abb1b774720e8f2e21f124c0f0f Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Mon, 16 Mar 2020 12:33:53 +0000 Subject: [PATCH] simplifies code contributions by fully automating the setup with gitpod. --- .github/CONTRIBUTING.md | 14 ++++++++++++++ .gitpod.yml | 13 +++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 .gitpod.yml diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 74ce28264..c0ff122d0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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. diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..0e55608cf --- /dev/null +++ b/.gitpod.yml @@ -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