diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e0adbb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# How to contribute + +It is essential to the development of PixiJS 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. + +## Reporting issues + +To report a bug, request a feature, or even ask a question, make use of the GitHub Issues +section for [PixiJS][issues]. When submitting an issue please take the following steps: + +1. **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. + +2. **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. + +3. **Include a live example.** After narrowing your code down to only the problem areas, make use +of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. + +4. **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. + +> NOTE: if you are looking for support, please visit the [FAQ][faq], [forums][forums] or go through +> the [tutorials][tutorials]. + +## Contributing Changes + +### Setting Up + +To setup for making changes you will need to take a few steps, we've outlined them below: + +1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because +pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. + +2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides +for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. + +3. Next, run `npm install` from within your clone of your fork. That will install dependencies +necessary to build PixiJS. + + +### Making a Change + +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 the `master` branch if it is an *urgent* hotfix. +- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. +- `next` - Make your change to `next` 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. + +### Testing Your Change + +You can test your change by using the automated tests packaged with PixiJS. 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. + +### Submitting Your Change + +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. + +## Quickie Code Style Guide + +- 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. + +[faq]: http://www.pixijs.com/faq +[fiddle]: http://jsfiddle.net +[fork-cli]: https://help.github.com/articles/fork-a-repo/ +[fork-gui]: https://guides.github.com/activities/forking/ +[forums]: http://www.html5gamedevs.com/forum/15-pixijs/ +[issues]: https://github.com/pixijs/pixi.js/issues +[jsbin]: http://jsbin.com/ +[node]: http://nodejs.org +[pixi]: https://github.com/pixijs/pixi.js +[tutorials]: http://www.pixijs.com/tutorials + +## Contributor Code of Conduct + +[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e0adbb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# How to contribute + +It is essential to the development of PixiJS 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. + +## Reporting issues + +To report a bug, request a feature, or even ask a question, make use of the GitHub Issues +section for [PixiJS][issues]. When submitting an issue please take the following steps: + +1. **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. + +2. **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. + +3. **Include a live example.** After narrowing your code down to only the problem areas, make use +of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. + +4. **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. + +> NOTE: if you are looking for support, please visit the [FAQ][faq], [forums][forums] or go through +> the [tutorials][tutorials]. + +## Contributing Changes + +### Setting Up + +To setup for making changes you will need to take a few steps, we've outlined them below: + +1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because +pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. + +2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides +for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. + +3. Next, run `npm install` from within your clone of your fork. That will install dependencies +necessary to build PixiJS. + + +### Making a Change + +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 the `master` branch if it is an *urgent* hotfix. +- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. +- `next` - Make your change to `next` 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. + +### Testing Your Change + +You can test your change by using the automated tests packaged with PixiJS. 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. + +### Submitting Your Change + +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. + +## Quickie Code Style Guide + +- 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. + +[faq]: http://www.pixijs.com/faq +[fiddle]: http://jsfiddle.net +[fork-cli]: https://help.github.com/articles/fork-a-repo/ +[fork-gui]: https://guides.github.com/activities/forking/ +[forums]: http://www.html5gamedevs.com/forum/15-pixijs/ +[issues]: https://github.com/pixijs/pixi.js/issues +[jsbin]: http://jsbin.com/ +[node]: http://nodejs.org +[pixi]: https://github.com/pixijs/pixi.js +[tutorials]: http://www.pixijs.com/tutorials + +## Contributor Code of Conduct + +[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..76b1b1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + + +Your issue may already be reported! Please search [existing issues](../) before creating one. + + + +### Expected Behavior + +### Current Behavior + +### Possible Solution + +### Steps to Reproduce + +### Environment + +- `pixi.js` version: _e.g. 4.7.1_ +- Browser: _e.g. Chrome 67_ +- Device: _e.g. Desktop_ diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e0adbb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# How to contribute + +It is essential to the development of PixiJS 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. + +## Reporting issues + +To report a bug, request a feature, or even ask a question, make use of the GitHub Issues +section for [PixiJS][issues]. When submitting an issue please take the following steps: + +1. **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. + +2. **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. + +3. **Include a live example.** After narrowing your code down to only the problem areas, make use +of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. + +4. **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. + +> NOTE: if you are looking for support, please visit the [FAQ][faq], [forums][forums] or go through +> the [tutorials][tutorials]. + +## Contributing Changes + +### Setting Up + +To setup for making changes you will need to take a few steps, we've outlined them below: + +1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because +pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. + +2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides +for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. + +3. Next, run `npm install` from within your clone of your fork. That will install dependencies +necessary to build PixiJS. + + +### Making a Change + +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 the `master` branch if it is an *urgent* hotfix. +- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. +- `next` - Make your change to `next` 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. + +### Testing Your Change + +You can test your change by using the automated tests packaged with PixiJS. 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. + +### Submitting Your Change + +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. + +## Quickie Code Style Guide + +- 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. + +[faq]: http://www.pixijs.com/faq +[fiddle]: http://jsfiddle.net +[fork-cli]: https://help.github.com/articles/fork-a-repo/ +[fork-gui]: https://guides.github.com/activities/forking/ +[forums]: http://www.html5gamedevs.com/forum/15-pixijs/ +[issues]: https://github.com/pixijs/pixi.js/issues +[jsbin]: http://jsbin.com/ +[node]: http://nodejs.org +[pixi]: https://github.com/pixijs/pixi.js +[tutorials]: http://www.pixijs.com/tutorials + +## Contributor Code of Conduct + +[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..76b1b1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + + +Your issue may already be reported! Please search [existing issues](../) before creating one. + + + +### Expected Behavior + +### Current Behavior + +### Possible Solution + +### Steps to Reproduce + +### Environment + +- `pixi.js` version: _e.g. 4.7.1_ +- Browser: _e.g. Chrome 67_ +- Device: _e.g. Desktop_ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e0adbb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# How to contribute + +It is essential to the development of PixiJS 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. + +## Reporting issues + +To report a bug, request a feature, or even ask a question, make use of the GitHub Issues +section for [PixiJS][issues]. When submitting an issue please take the following steps: + +1. **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. + +2. **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. + +3. **Include a live example.** After narrowing your code down to only the problem areas, make use +of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. + +4. **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. + +> NOTE: if you are looking for support, please visit the [FAQ][faq], [forums][forums] or go through +> the [tutorials][tutorials]. + +## Contributing Changes + +### Setting Up + +To setup for making changes you will need to take a few steps, we've outlined them below: + +1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because +pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. + +2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides +for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. + +3. Next, run `npm install` from within your clone of your fork. That will install dependencies +necessary to build PixiJS. + + +### Making a Change + +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 the `master` branch if it is an *urgent* hotfix. +- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. +- `next` - Make your change to `next` 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. + +### Testing Your Change + +You can test your change by using the automated tests packaged with PixiJS. 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. + +### Submitting Your Change + +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. + +## Quickie Code Style Guide + +- 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. + +[faq]: http://www.pixijs.com/faq +[fiddle]: http://jsfiddle.net +[fork-cli]: https://help.github.com/articles/fork-a-repo/ +[fork-gui]: https://guides.github.com/activities/forking/ +[forums]: http://www.html5gamedevs.com/forum/15-pixijs/ +[issues]: https://github.com/pixijs/pixi.js/issues +[jsbin]: http://jsbin.com/ +[node]: http://nodejs.org +[pixi]: https://github.com/pixijs/pixi.js +[tutorials]: http://www.pixijs.com/tutorials + +## Contributor Code of Conduct + +[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..76b1b1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + + +Your issue may already be reported! Please search [existing issues](../) before creating one. + + + +### Expected Behavior + +### Current Behavior + +### Possible Solution + +### Steps to Reproduce + +### Environment + +- `pixi.js` version: _e.g. 4.7.1_ +- Browser: _e.g. Chrome 67_ +- Device: _e.g. Desktop_ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index fb094a1..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,74 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at mat@goodboydigital.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e0adbb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# How to contribute + +It is essential to the development of PixiJS 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. + +## Reporting issues + +To report a bug, request a feature, or even ask a question, make use of the GitHub Issues +section for [PixiJS][issues]. When submitting an issue please take the following steps: + +1. **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. + +2. **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. + +3. **Include a live example.** After narrowing your code down to only the problem areas, make use +of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. + +4. **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. + +> NOTE: if you are looking for support, please visit the [FAQ][faq], [forums][forums] or go through +> the [tutorials][tutorials]. + +## Contributing Changes + +### Setting Up + +To setup for making changes you will need to take a few steps, we've outlined them below: + +1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because +pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. + +2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides +for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. + +3. Next, run `npm install` from within your clone of your fork. That will install dependencies +necessary to build PixiJS. + + +### Making a Change + +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 the `master` branch if it is an *urgent* hotfix. +- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. +- `next` - Make your change to `next` 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. + +### Testing Your Change + +You can test your change by using the automated tests packaged with PixiJS. 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. + +### Submitting Your Change + +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. + +## Quickie Code Style Guide + +- 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. + +[faq]: http://www.pixijs.com/faq +[fiddle]: http://jsfiddle.net +[fork-cli]: https://help.github.com/articles/fork-a-repo/ +[fork-gui]: https://guides.github.com/activities/forking/ +[forums]: http://www.html5gamedevs.com/forum/15-pixijs/ +[issues]: https://github.com/pixijs/pixi.js/issues +[jsbin]: http://jsbin.com/ +[node]: http://nodejs.org +[pixi]: https://github.com/pixijs/pixi.js +[tutorials]: http://www.pixijs.com/tutorials + +## Contributor Code of Conduct + +[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..76b1b1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + + +Your issue may already be reported! Please search [existing issues](../) before creating one. + + + +### Expected Behavior + +### Current Behavior + +### Possible Solution + +### Steps to Reproduce + +### Environment + +- `pixi.js` version: _e.g. 4.7.1_ +- Browser: _e.g. Chrome 67_ +- Device: _e.g. Desktop_ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index fb094a1..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,74 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at mat@goodboydigital.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index d791c16..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,86 +0,0 @@ -# How to contribute - -It is essential to the development of PixiJS 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. - -## Reporting issues - -To report a bug, request a feature, or even ask a question, make use of the GitHub Issues -section for [PixiJS][issues]. When submitting an issue please take the following steps: - -1. **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. - -2. **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. - -3. **Include a live example.** After narrowing your code down to only the problem areas, make use -of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. - -4. **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. - -## Contributing Changes - -### Setting Up - -To setup for making changes you will need to take a few steps, we've outlined them below: - -1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because -pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. - -2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides -for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. - -3. Next, run `npm install` from within your clone of your fork. That will install dependencies -necessary to build PixiJS. - - -### Making a Change - -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 the `master` branch if it is an *urgent* hotfix. -- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. -- `next` - Make your change to `next` 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. - -### Testing Your Change - -You can test your change by using the automated tests packaged with PixiJS. 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. - -### Submitting Your Change - -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. - -## Quickie Code Style Guide - -- 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. - -[issues]: https://github.com/pixijs/pixi.js/issues -[pixi]: https://github.com/pixijs/pixi.js -[fiddle]: http://jsfiddle.net -[jsbin]: http://jsbin.com/ -[node]: http://nodejs.org -[fork-cli]: https://help.github.com/articles/fork-a-repo/ -[fork-gui]: https://guides.github.com/activities/forking/ - -## Contributor Code of Conduct - -[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fb094a1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mat@goodboydigital.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e0adbb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# How to contribute + +It is essential to the development of PixiJS 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. + +## Reporting issues + +To report a bug, request a feature, or even ask a question, make use of the GitHub Issues +section for [PixiJS][issues]. When submitting an issue please take the following steps: + +1. **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. + +2. **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. + +3. **Include a live example.** After narrowing your code down to only the problem areas, make use +of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. + +4. **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. + +> NOTE: if you are looking for support, please visit the [FAQ][faq], [forums][forums] or go through +> the [tutorials][tutorials]. + +## Contributing Changes + +### Setting Up + +To setup for making changes you will need to take a few steps, we've outlined them below: + +1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because +pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. + +2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides +for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. + +3. Next, run `npm install` from within your clone of your fork. That will install dependencies +necessary to build PixiJS. + + +### Making a Change + +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 the `master` branch if it is an *urgent* hotfix. +- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. +- `next` - Make your change to `next` 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. + +### Testing Your Change + +You can test your change by using the automated tests packaged with PixiJS. 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. + +### Submitting Your Change + +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. + +## Quickie Code Style Guide + +- 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. + +[faq]: http://www.pixijs.com/faq +[fiddle]: http://jsfiddle.net +[fork-cli]: https://help.github.com/articles/fork-a-repo/ +[fork-gui]: https://guides.github.com/activities/forking/ +[forums]: http://www.html5gamedevs.com/forum/15-pixijs/ +[issues]: https://github.com/pixijs/pixi.js/issues +[jsbin]: http://jsbin.com/ +[node]: http://nodejs.org +[pixi]: https://github.com/pixijs/pixi.js +[tutorials]: http://www.pixijs.com/tutorials + +## Contributor Code of Conduct + +[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..76b1b1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + + +Your issue may already be reported! Please search [existing issues](../) before creating one. + + + +### Expected Behavior + +### Current Behavior + +### Possible Solution + +### Steps to Reproduce + +### Environment + +- `pixi.js` version: _e.g. 4.7.1_ +- Browser: _e.g. Chrome 67_ +- Device: _e.g. Desktop_ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index fb094a1..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,74 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at mat@goodboydigital.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index d791c16..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,86 +0,0 @@ -# How to contribute - -It is essential to the development of PixiJS 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. - -## Reporting issues - -To report a bug, request a feature, or even ask a question, make use of the GitHub Issues -section for [PixiJS][issues]. When submitting an issue please take the following steps: - -1. **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. - -2. **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. - -3. **Include a live example.** After narrowing your code down to only the problem areas, make use -of [jsFiddle][fiddle], [jsBin][jsbin], or a link to your live site so that we can view a live example of the problem. - -4. **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. - -## Contributing Changes - -### Setting Up - -To setup for making changes you will need to take a few steps, we've outlined them below: - -1. Ensure you have node.js installed. You can download node.js from [nodejs.org][node]. Because -pixi uses modern JS features, you will need a modern version of node. v4+ is recommended. - -2. Fork the **[pixi.js][pixi]** repository, if you are unsure how to do this GitHub has a guides -for the [command line][fork-cli] and for the [GitHub Client][fork-gui]. - -3. Next, run `npm install` from within your clone of your fork. That will install dependencies -necessary to build PixiJS. - - -### Making a Change - -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 the `master` branch if it is an *urgent* hotfix. -- `dev` - Make your change to `dev` if it is a *non-urgent* bugfix or a backwards-compatible feature. -- `next` - Make your change to `next` 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. - -### Testing Your Change - -You can test your change by using the automated tests packaged with PixiJS. 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. - -### Submitting Your Change - -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. - -## Quickie Code Style Guide - -- 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. - -[issues]: https://github.com/pixijs/pixi.js/issues -[pixi]: https://github.com/pixijs/pixi.js -[fiddle]: http://jsfiddle.net -[jsbin]: http://jsbin.com/ -[node]: http://nodejs.org -[fork-cli]: https://help.github.com/articles/fork-a-repo/ -[fork-gui]: https://guides.github.com/activities/forking/ - -## Contributor Code of Conduct - -[Code of Conduct](CODE_OF_CONDUCT.md) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4) diff --git a/README.md b/README.md index ae912d1..47c3a60 100644 --- a/README.md +++ b/README.md @@ -60,16 +60,15 @@ #### CDN Install (via cdnjs) ```html - + ``` -_Note: `4.5.1` can be replaced by any [released](https://github.com/pixijs/pixi.js/releases) version._ +_Note: `4.7.1` can be replaced by any [released](https://github.com/pixijs/pixi.js/releases) version._ ### Demos ### - [Filters Demo](http://pixijs.io/pixi-filters/tools/demo/) - [Run Pixie Run](http://work.goodboydigital.com/runpixierun/) -- [Fight for Everyone](http://www.goodboydigital.com/casestudies/fightforeveryone) - [Flash vs HTML](http://flashvhtml.com) - [Bunny Demo](http://www.goodboydigital.com/pixijs/bunnymark) - [Storm Brewing](http://www.goodboydigital.com/pixijs/storm) @@ -89,7 +88,7 @@ together :) Whether you find a bug, have a great feature request or you fancy owning a task from the road map above feel free to get in touch. -Make sure to read the [Contributing Guide](https://github.com/pixijs/pixi.js/blob/master/CONTRIBUTING.md) +Make sure to read the [Contributing Guide](.github/CONTRIBUTING.md) before submitting changes. ### Current features ###