Skip to content
This repository has been archived by the owner on Jul 2, 2020. It is now read-only.

Latest commit

 

History

History
23 lines (12 loc) · 2.35 KB

Contributing.md

File metadata and controls

23 lines (12 loc) · 2.35 KB

So how do I add my stuff to Sonic Outbreak?

PM or message me (Sslaxx) on Discord if at any point you're stuck! I'll do my best to help. Or use the issue tracker on GitHub.

It's not going to be massively straight-forward, sorry, but I hope I can get across what you need to do.

First of all, never commit directly to master. The master branch is what's going to be used for stable builds of the game. Though it can never be guaranteed, obviously, avoiding merging everything into master straight off reduces the likelihood of it being unstable/making unplayable builds.

There are tools out there like TortoiseGit https://tortoisegit.org/ out there if you don't want to have to deal with the command line stuff. Git itself comes with a GUI you can use to do things like cloning, committing, pushing etc. https://git-scm.com/download/

So what do I do, then?

First of all, clone the repository (i.e., create a local copy of it that you can work on). From the command line, something like git clone https://github.com/Sslaxx/Sonic_Outbreak would create a directory called Sonic_Outbreak, wherever you ran the command.

If you want to add a new feature (new gimmick, new badnik or zone, etc.) or fix one of the (plenty of) bugs in the code, first of all create a new branch, giving it a name that (hopefully!) describes what you want it to do. How you create branches in a GUI depends on what Git client you're using, but from the command line this should work: git checkout -b fix_backwards_flying_hedgehogs

And then you'll have a new branch called fix_backwards_flying_hedgehogs. Everything you add or commit to the repo will then be to that branch. Do git checkout master to switch to master at any point if you need (or, indeed, any other branch). https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging has more info on this.

You'll need to commit and then push your changes to the branch. https://git-scm.com/docs/git-push tells you how to do this from the command line.

When you think it's ready, go to https://github.com/Sslaxx/Sonic_Outbreak/pulls and create a new pull request. Describe what your changes are. https://help.github.com/articles/about-pull-requests/ has more info too.

When it's all good, the changes will be merged into master, and the branch you created after will be deleted (so remember to switch back to master on your local copy!).