How to contribute

Getting Started

Make sure you have a GitHub account.
Fork this repository on GitHub.
On your local machine, clone your fork of the repository.

Making Changes

Add code to your local fork. It's usually a good idea to make changes on a branch with the branch name relating to the feature you are going to add.
When you are ready for others to examine and comment on your new feature, navigate to your fork of TheNinjaRPG on GitHub and open a pull request (PR). Note that after you launch a PR from one of your fork's branches, all subsequent commits to that branch will be added to the open pull request automatically.
When the PR is approved it will be merged into main and automatically deployed onto www.theninja-rpg.com

Code Conventions

Code should be as readable as possible; hard to understand logic requires comments. Too many comments is not good though, see this video.
We use gitmoji for commits, to make things a bit more 🔥
It is expected that code complies with the ESlint and prettier settings in this repo.