It is essential to the development of pixi.js that the community is empowered to make changes and get them into the library. Here are some guidelines to make that process silky smooth for all involved.
To report a bug, request a feature, or even ask a question, make use of the GitHub Issues section for pixi.js. When submitting an issue please take the following steps:
-
Seach for existing issues. Your question or bug may have already been answered or fixed, be sure to search the issues first before putting in a duplicate issue.
-
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.
-
Include a live example. After narrowing your code down to only the problem areas, make use of jsFiddle, jsBin, or a link to your live site so that we can view a live example of the problem.
-
Share as much information as possible. Include browser version affected, your OS, version of the library, steps to reproduce, etc. "X isn't working!!!1!" will probably just be closed.
To setup for making changes you will need to take a few steps, we've outlined them below:
-
Ensure you have node.js installed. You can download node.js from nodejs.org. Because pixi uses modern JS features, you will need a modern version of node. v4+ is recommended.
-
Fork the pixi.js repository, if you are unsure how to do this GitHub has a guides for the command line and for the GitHub Client.
-
Next, run
npm install
from within your clone of your fork. That will install dependencies necessary to build pixi.js
Once you have node.js, the repository, and have installed dependencies are you almost ready to make your change. The only other thing before you start is to checkout the correct branch. Which branch you should make your change to (and send a PR to) depends on the type of change you are making.
Here is our branch breakdown:
master
- Make your change to themaster
branch if it is an urgent hotfix.dev
- Make your change todev
if it is a non-urgent bugfix or a backwards-compatible feature.next
- Make your change tonext
if it is a breaking change, or wild/crazy idea.
Your change should be made directly to the branch in your fork, or to a branch in your fork made off of one of the above branches.
You can test your change by using the automated tests packaged with pixi.js. You can run these tests
by running npm test
from the command line. If you fix a bug please add a test that will catch that
bug if it ever happens again. This prevents regressions from sneaking in.
After you have made and tested your change, commit and push it to your fork. Then, open a Pull Request
from your fork to the main pixi.js repository on the branch you used in the Making a Change
section of this document.
- 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.
- Ensure changes are eslint validated. After making a change be sure to run the build process
to ensure that you didn't break anything. You can do this with
npm test
which will run eslint, rebuild, then run the test suite.
Code of Conduct is adapted from Contributor Covenant, version 1.4