Contributing

If you wish to contribute to this project, be sure to follow these steps:

• Get the latest version from the master branch.
• Create a separate branch for a new patch or feature, using the following naming conventions:
  • patch/<short-description> for bug fixes / minor improvements.
  • feature/<short-description> for new features / major revisions / anything that doesn't fit the patch category.
• Once done with a patch / feature do not add more commits to that branch unless it needs revision.
  (Pull requests are not repository state snapshots, any change you do in that branch will be included in the pull request).
• Make sure you adhere to the style guide.
• Don't include build files in pull requests.
• If some GitHub issue is relevant to patch / feature, it's good to mention the issue number (e.g. #42) in the pull request to get cross-reference in GitHub web interface.
• If you add assets (like textures, models, sounds, etc), make sure they have a proper license allowing for their use here (less restrictive the better).
• On your own branch, git fetch, git rebase master and resolve any conflicts before submitting your pull request.
• Create a pull request with your branch.
• If the request is merged, delete your branch.

It might look like much, but fear not! We're happy to lend a hand if you get stuck or make a mistake. After all, we're all still learning here.