Skip to content

Commit 65cc4cc

Browse files
committed
Updates for Phaser CE and the split versions.
1 parent 710cd68 commit 65cc4cc

5 files changed

Lines changed: 65 additions & 581 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
It's important to us that you feel you can contribute towards the evolution of Phaser. This can take many forms: from helping to fix bugs or improve the docs, to adding in new features to the source. This guide should help you in making that process as smooth as possible.
44

5-
Before contributing, please read the [code of conduct](https://github.com/photonstorm/phaser/blob/master/CODE_OF_CONDUCT.md).
5+
Before contributing, please read the [code of conduct](https://github.com/photonstorm/phaser/blob/master/v2/CODE_OF_CONDUCT.md).
66

77
##Reporting issues
88

9-
[GitHub Issues][0] is the place to report bugs you may have found in either the core library or any of the examples that are part of the repository. When submitting a bug please do the following:
9+
[GitHub Issues][0] is the place to report bugs you may have found. When submitting a bug please do the following:
1010

11-
**1. Search for existing issues.** Your bug may have already been fixed or addressed in a development branch version of Phaser, so be sure to search the issues first before putting in a duplicate issue.
11+
**1. Search for existing issues.** Your bug may have already been fixed, or cannot, or will not, be fixed. So be sure to search the issues first before putting in a duplicate issue.
1212

13-
**2. Not sure if it's a bug?.** Then please ask on the [forum][4]. If something is blatantly wrong then post it to github. But if you feel it might just be because you're not sure of expected behaviour, then it might save us time, and get you a response faster, if you post it to the Phaser forum instead.
13+
**2. Not sure if it's a bug?.** Please ask on the [forum][4]. If something is blatantly wrong then post it to GitHub. But if you feel it might just be because you're not sure of expected behavior, then it might save us time, and get you a response faster, if you post it to the Phaser forum instead.
1414

1515
**3. Create an isolated and reproducible test case.** If you are reporting a bug, make sure you also have a minimal, runnable, code example that reproduces the problem you have.
1616

@@ -21,19 +21,14 @@ Before contributing, please read the [code of conduct](https://github.com/photon
2121

2222
##Pixi and Phaser
2323

24-
It's important to understand that internally Phaser uses [Pixi.js](https://github.com/GoodBoyDigital/pixi.js/) for all rendering. It's possible you may find a bug that is generated on the Pixi level rather than Phaser. You're welcome to still report the issue of course, but if you get a reply saying we think it might be a Pixi issue this is what we're talking about :)
24+
It's important to understand that internally Phaser 2 uses a heavily customized version of [Pixi.js v2](https://github.com/GoodBoyDigital/pixi.js/) for all rendering. It's possible you may find a bug that is generated on the Pixi level rather than Phaser. You're welcome to still report the issue of course, but if you get a reply saying we think it might be a Pixi issue, this is what we're talking about :)
2525

2626

2727
##Support Forum
2828

2929
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 and Pixi teams, so it's a great place to get support from. You're welcome to report bugs directly on GitHub, but for general support we'd always recommend using the forum first.
3030

3131

32-
##Dev vs. Master
33-
34-
The dev branch of Phaser is our 'current working' version. It is always ahead of the master branch in terms of features and fixes. However it's also bleeding-edge and experimental and we cannot and do not guarantee it will compile or work for you. Very often we have to break things for a few days while we rebuild and patch. So by all means please export the dev branch and contribute towards it, indeed that is where all Pull Requests should be sent, but do so understanding the API may change beneath you.
35-
36-
3732
##Making Changes
3833

3934
To take advantage of our grunt build script and jshint config it will be easiest for you if you have node.js and grunt installed locally.
@@ -43,7 +38,7 @@ You can download node.js from [nodejs.org][3]. After it has been installed open
4338
After that you can clone the repository and run `npm i` inside the cloned folder. This will install dependencies necessary for building the project. Once that is ready,
4439
make your changes and submit a Pull Request:
4540

46-
- **Send Pull Requests to the `dev` branch.** All Pull Requests must be sent to the `dev` branch, `master` is the latest release and PRs to that branch will be closed.
41+
- **Send Pull Requests to the `master` branch.** We _used_ to insist PRs went to `dev` but have removed this policy since the release of Phaser CE.
4742

4843
- **Ensure changes are jshint validated.** Our JSHint configuration file is provided in the repository and you should check against it before submitting.
4944

.github/ISSUE_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
Before opening this issue _please_ check we haven't already fixed it! Development always takes place in the Phaser `dev` branch. The easiest way to check is to read the [Dev Change Log](https://github.com/photonstorm/phaser/tree/dev#change-log).
1+
Before opening this issue _please_ check we haven't already fixed it! Check the [Dev Change Log](https://github.com/photonstorm/phaser/tree/master/v2-community/#change-log).
22

33
This Issue is about (delete as applicable)
44

5-
* A bug in the API
5+
* A bug in the API (always say which version you're using!)
66
* An error in the documentation
77
* An error in the TypeScript defs
88
* An error on the web site
99
* A problem with my own code
1010

11-
API errors must include example code showing what happens, and why you don't believe this is the expected behavior. Issues posted without code take _far_ longer to get resolved, sometimes not ever.
11+
API errors must include example code showing what happens, and why you don't believe this is the expected behavior. Issues posted without code take _far_ longer to get resolved, _if ever_.
1212

13-
If the issue is in a current version of Phaser, then you can use the [Phaser Sandbox](http://phaser.io/sandbox) to demonstrate it. Otherwise feel free to use another service, such as jsbin, or if you really must, codepen. If we can run it, and see the error, we can usually fix it.
13+
If the issue is in a current version of Phaser, then you can use the [Phaser Sandbox](http://phaser.io/sandbox) to demonstrate it. Otherwise feel free to use another service, such as jsbin. If we can run it, and see the error, we can usually fix it.
1414

1515
If your Issue contains _any_ form of hostility it will be instantly closed.
1616

17-
**Be nice.**
17+
**Be nice. We do this for free.**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
**Important:** Pull Requests should _only_ be issued against the `dev` branch. PRs against the master branch will always be closed.
2-
31
This PR changes (delete as applicable)
42

53
* Documentation

0 commit comments

Comments
 (0)