You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
3
3
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.
4
4
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).
6
6
7
7
##Reporting issues
8
8
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:
10
10
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.
12
12
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.
14
14
15
15
**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.
16
16
@@ -21,19 +21,14 @@ Before contributing, please read the [code of conduct](https://github.com/photon
21
21
22
22
##Pixi and Phaser
23
23
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 :)
25
25
26
26
27
27
##Support Forum
28
28
29
29
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.
30
30
31
31
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
-
37
32
##Making Changes
38
33
39
34
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
43
38
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,
44
39
make your changes and submit a Pull Request:
45
40
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.
47
42
48
43
-**Ensure changes are jshint validated.** Our JSHint configuration file is provided in the repository and you should check against it before submitting.
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).
2
2
3
3
This Issue is about (delete as applicable)
4
4
5
-
* A bug in the API
5
+
* A bug in the API (always say which version you're using!)
6
6
* An error in the documentation
7
7
* An error in the TypeScript defs
8
8
* An error on the web site
9
9
* A problem with my own code
10
10
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_.
12
12
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.
14
14
15
15
If your Issue contains _any_ form of hostility it will be instantly closed.
0 commit comments