mirror of
https://github.com/photonstorm/phaser
synced 2024-11-10 07:04:31 +00:00
Updated github templates
This commit is contained in:
Richard Davey
parent
ccb2ed5f50
commit
a4691108b4
4 changed files with 31 additions and 37 deletions
41
.github/CONTRIBUTING.md
vendored
41
.github/CONTRIBUTING.md
vendored
|
|
@ -18,54 +18,57 @@ Before contributing, please read the [code of conduct](https://github.com/photon
|
|||
|
||||
**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!!!1!" will probably just be closed.
|
||||
|
||||
|
||||
## Pixi and Phaser
|
||||
|
||||
Phaser doesn't use Pixi anymore.
|
||||
|
||||
|
||||
## Support Forum
|
||||
|
||||
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.
|
||||
|
||||
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 team, so it's a great place to get support. You're welcome to report bugs directly on GitHub, but for general support we'd always recommend using the forum first.
|
||||
|
||||
## Making Changes
|
||||
|
||||
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.
|
||||
I'm assuming you already have a recent version of [Node](https://nodejs.org) installed locally and can run `npm`. This guide is tested and works on both Windows 10 and OS X.
|
||||
|
||||
You can download node.js from [nodejs.org][3]. After it has been installed open a console and run `npm i -g grunt-cli` to install the global `grunt` executable.
|
||||
### 1. Checkout the repos
|
||||
|
||||
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:
|
||||
Check-out both the [Phaser repo](https://github.com/photonstorm/phaser) and the [Phaser 3 Examples Repo](https://github.com/photonstorm/phaser3-examples). Make sure the Phaser 3 Examples repo is saved locally in a folder called `phaser3-examples`, which will be the default for most Git clients.
|
||||
|
||||
- **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.
|
||||
### 2. Matching Directory Levels
|
||||
|
||||
- **Ensure changes are jshint validated.** Our JSHint configuration file is provided in the repository and you should check against it before submitting.
|
||||
Ensure that both repos live at the same depth in your directory structure. For example: `/usr/home/web/phaser` and `/usr/home/web/phaser3-examples`. This is so the dev build scripts in the Phaser repo can safely copy files to `../phaser3-examples` and have them end up in the correct place.
|
||||
|
||||
- **Never commit new builds.** When making a code change you should always run `grunt` which will rebuild the project so you can test, *however* please do not commit these new 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.
|
||||
### 3. Install dependencies
|
||||
|
||||
- **Only commit relevant changes.** 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.
|
||||
Using your console, run `npm install` or `yarn install` as we've configs for both. This process will install a local copy of webpack and a handful of small support scripts. Note that Yarn on Windows seems to have issues making some packages global, so stick with npm if this is the case.
|
||||
|
||||
### 4. Webpack
|
||||
|
||||
Making sure you've got both repos checked out, and at the same directory level in your filesystem, issue the command `webpack`. If you can't issue the command then webpack may need [installing globally](https://webpack.js.org/guides/installation/). Webpack will build Phaser and if there are any path errors in the code they'll be flagged during the build process.
|
||||
|
||||
What you need is the ability to issue the command `webpack` within the v3 folder and have it work.
|
||||
|
||||
### 5. ESLint
|
||||
|
||||
There is an ESLint configuration and an Editor Configuration in the v3 folder. **Please adhere to them!** Although not enforced in the build process yet, I will be adding that at a later point. There are lots of tools you can install so your editor of choice will check the ESLint config during development.
|
||||
|
||||
To test if your code passes our lint config issue the command `npm run lint`.
|
||||
|
||||
## Coding style preferences are not contributions
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## I don't really like git / node.js, but I can fix this bug
|
||||
|
||||
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 re: JSHint, etc.
|
||||
|
||||
|
||||
## Code Style Guide
|
||||
|
||||
We provide an .editorconfig and eslint config for you to use, but generally:
|
||||
|
||||
- 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 jshint. Our config is set-up for a reason.
|
||||
- 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.
|
||||
|
||||
|
|
|
|||
14
.github/ISSUE_TEMPLATE.md
vendored
14
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,17 +1,9 @@
|
|||
**This repo is for Phaser 3 related issues only**
|
||||
This repo is for Phaser 3 related issues only. If you've found an issue with Phaser 2 please see the [Phaser CE (Community Edition)](https://github.com/photonstorm/phaser-ce) repo instead.
|
||||
|
||||
Official support for Phaser 2 has now ended. We urge you to visit the [Phaser CE (Community Edition)](https://github.com/photonstorm/phaser-ce) for continued development of v2.
|
||||
|
||||
This Issue is about (delete as applicable)
|
||||
|
||||
* A bug in the API (always say which version you're using!)
|
||||
* An error in the documentation
|
||||
* An error in the TypeScript defs
|
||||
* An error on the web site
|
||||
* A problem with my own code
|
||||
This should not be used for technical support. If you're struggling trying to use Phaser then post your question to the [forum](http://www.html5gamedevs.com/forum/33-phaser-3/), [Slack](https://phaser.io/community/slack) or [Discord](https://phaser.io/community/discord) channels. GitHub Issues are for bugs and feature requests only.
|
||||
|
||||
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_. Feel free to use a site such as jsBin or [CodePen](https://codepen.io/pen?template=YeEWom) to demo the problem. If we can run it, and see the error, we can usually fix it.
|
||||
|
||||
If your Issue contains _any_ form of hostility it will be instantly closed.
|
||||
If your Issue contains _any_ form of hostility it will be instantly closed and you will be blocked from access to all our repos.
|
||||
|
||||
**Be nice. We do this for free.**
|
||||
|
|
|
|||
11
.github/PULL_REQUEST_TEMPLATE.md
vendored
11
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,11 +1,10 @@
|
|||
** >> Make sure you describe your PR to the README Change Log section! << **
|
||||
Please do not update the README or Change Log, we will do this when we merge your PR.
|
||||
|
||||
This PR changes (delete as applicable)
|
||||
This PR (delete as applicable)
|
||||
|
||||
* Documentation
|
||||
* TypeScript Defs
|
||||
* The public-facing API
|
||||
* Nothing, it's a bug fix
|
||||
* Updates the Documentation
|
||||
* Adds a new feature
|
||||
* Fixes a bug
|
||||
|
||||
Describe the changes below:
|
||||
|
||||
|
|
|
|||
|
|
@ -470,4 +470,4 @@ All rights reserved.
|
|||
[issues]: https://github.com/photonstorm/phaser/issues
|
||||
[examples]: https://github.com/photonstorm/phaser3-examples
|
||||
[contribute]: https://github.com/photonstorm/phaser/blob/master/.github/CONTRIBUTING.md
|
||||
[forum]: http://www.html5gamedevs.com/forum/14-phaser/
|
||||
[forum]: http://www.html5gamedevs.com/forum/33-phaser-3/
|
||||
|
|
|
|||
Loading…
Reference in a new issue