Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 2.32 KB

Contribution Guide

This project has been created for open source beginners. No contributions are too small; give it a go!

Basics

Features

New features are not only welcome, but also encouraged!

Suggested:

  • New Characters
  • New Enemies
  • New Levels
  • Control Systems

Play the game, and if you have any suggestions, create a new issue outlining what you propose. Alternatively, look at the current open issues that haven't been assigned to other contributors.

How to Contribute

  1. Fork this repo: click 'Fork' at the top!

  2. Navigate to a location on your local computer.

  3. Clone the forked repo from your account.

    git clone [your forked repository URL]

  4. Create a new local branch

    git checkout -b [local branch name]

  5. Use an editor of your choice to make changes.

  6. Stages your changes frequently!

    git add .

  7. Once you are happy with the changes you have made, commit them.

    git commit -m "Your commit message"

  8. Move back to the master branch.

    git checkout master

  9. Merge your local branch to the master branch.

    git merge [local branch name]

  10. Push the commit to your forked repository.

    git push origin master

  11. Submit a pull request!

Tips

  • If you're working on an open issue, place a comment on it so others know it's in progress.
  • Use the issue description you're working on for your commit message, e.g. "Issue #10 Updated README.md".
  • If you're not working on one of the existing issues, remember to create a new one before you submit a pull request.
  • If another contributor has commented on an issue, this usually means they're working on it. Have a look at the comments before you begin working.
  • Before you create a new pull request, test your changes to ensure they work correctly. Try playing the game a few times in different browsers, e.g. Chrome/Firefox/Opera/Safari.