Contribution Guide
==================

TBD.

Contribution Guidelines
=======================

Thank you for contributing to `generator-phaser-plus`. Here are a few ways you can contribute to this project.

-   **Reporting problems**. If you found problems with the generator or sample projects, do not hesitate and report them as soon as possible.

-   **Improving documentation**. You can suggest improvements to the documentation, providing grammar and typo corrections.

    >   Note: At the moment, proposals for localization of content in other languages are not being accepted.

-   **Suggesting improvements and new features**. Feel free to suggest improvements or new features to the generator and its sample projects. Please, be sure these were not [suggested before](/rblopes/generator-phaser-plus/issues?utf8=✓&q=label%3AFEATURE%20) or are already on the project [road map](road-map.md).

-   **Help spread the word**. The easiest contribution you can make to this project is starring its repository on GitHub. It helps the project grow on popularity and attract more interested users and contributors alike.


## A Note Regarding Pull Requests

For the time being, I am not accepting pull requests to change the generator behavior for a few reasons:

1.  **A complete revamp of the repository contents is overdue**. Perhaps the most annoying fact about this project is splitting the generator and its template projects in two distinct branches. Moving to a true "monorepo" model, keeping these in the `master` branch will lessen the entry gap for new contributors, and also open room for future planned expansions of the project.

2.  **A development guide of sorts is being worked on**. For those not very familiar with Yeoman or Node.js in general, its welcoming and sensible to provide a simple guide demonstrating the required steps for developing and submitting changes to the project. Such guide will also help establish guidelines for contributions.

>   It doesn't mean I don't welcome or will blindly reject any code contributions. However, unless you really prove you know your way around the development tools and this repository peculiarities, I cannot accept pull requests before overcoming the aforementioned issues first.

Put together the initial "Contribution Guide" page.
Put together the initial "Contribution Guide" page.
