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.
Before contributing, please read the code of conduct.
GitHub Issues is the place to report bugs you may have found. When submitting a bug please do the following:
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.
2. Not sure if it's a bug?. Please ask on the forum. 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.
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.
4. Include a live example. After narrowing your code down to only the problem areas, make use of our Phaser CE game template, jsFiddle, jsBin, or a link to your live site so that we can view a live example of the problem.
5. Share as much information as possible. Include browser version affected, your OS, version of the library, steps to reproduce, etc. "X isn't working!!!!!" will probably just be closed.
It's important to understand that internally Phaser 2 uses a heavily customized version of Pixi.js v2 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 :)
We have a very active Phaser Support Forum. 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.
To take advantage of our grunt build script and linter it will be easiest for you if you have node.js and grunt installed locally.
You can download node.js from nodejs.org. After it has been installed open a console and run npm i -g grunt-cli to install the global grunt executable.
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, make your changes and submit a Pull Request:
We used to insist PRs went to dev but have removed this policy since the release of Phaser CE.
Run npm run test or use an ESLint plugin in your editor.
When making a code change you should always run grunt test and test the generated script, dist/phaser-test.js. Please do not commit these test builds or your PR will be closed. Builds by default are placed in the dist folder, to keep them separate from the build folder releases.
Don't edit the *.comments.d.ts files. Those will be generated later when a new release is built.
Run npm run test:ts.
Don't include changes that are not directly relevant to the fix you are making. The more focused a PR is, the faster it will get attention and be merged. Extra files changing only whitespace or trash files will likely get your PR closed.
If your PR is doing little more than changing the Phaser source code into a format / coding style that you prefer then we will automatically close it. All PRs must adhere to the coding style already set-out across the thousands of lines of code in Phaser. Your personal preferences for how things should "look" or be structured do not apply here, sorry. PRs should fix bugs, fix documentation or add features. No changes for the sake of change.
That is fine too. While Pull Requests are the best thing in the world for us, they are not the only way to help. You're welcome to post fixes to our forum or even just email them to us. All we ask is that you still adhere to the guidelines presented here.
-
Use 4 spaces for tabs, never tab characters.
-
No trailing whitespace, blank lines should have no whitespace.
-
Always favor strict equals
===unless you need to use type coercion. -
Follow conventions already in the code, and listen to ESLint. Our config is set-up for a reason.
Thanks to Chad for creating the original Pixi.js Contributing file which we adapted for Phaser.