-
Notifications
You must be signed in to change notification settings - Fork 99
How To Contribute
Rhicora edited this page Nov 4, 2018
·
9 revisions
First steps: you'll only have to do these once, but be sure to do them exactly.
- Make a Github account: https://github.com/join
- Go to https://github.com/Persistent-SS13/Persistent-Bay and click the Fork button in the upper right. This creates your own personal copy of the code.
- Now we're going to make a place for the files. Open up Command Prompt (keep this window open) and type mkdir projects followed by cd projects.
- Type git config --global user.email "[your email]" where that email is the one you used to sign up. This makes sure all your contributions are in your name.
- Type git clone https://github.com/[your github username]/Persistent-Bay.git. You'll see your copy of Persistence project being copied again to your machine.
- Type cd Persistent-Bay to enter that directory. You may also want to have the same folders open in File Explorer for later.
- Type git remote add upstream https://github.com/Persistent-SS13/Persistent-Bay. This lets you pull in the latest changes from the official Persistence.
Congrats! You're all set up to contribute!
How to make a change after you're set up:
- In Command Prompt, type git pull upstream dev to bring in the latest changes.
- Type git checkout -b [give-clown-extra-backpack]. Name it based on what you plan to do. This creates a branch; a set of changes you want to make to the project.
- You can type git status now if you want, and see that you're on that branch - but also that there are no changes yet.
- Open the files you want to edit in some form of editor; it's up to you! Dream Maker itself works (double click persistentss13.dme), but we also recommend Atom or Sublime Text.
- Type the changes you want. Supply crates are a great starting point, they're located in https://github.com/Persistent-SS13/Persistent-Bay/tree/dev/code/datums/supplypacks
- Save your work (CTRL-S). Now that you have set /obj/item/weapon/storage/backpack/clown = 2, the clown will get two backpacks per crate. Time to commit our changes!
- Go back to your Command Prompt. Type git add . and git commit -m "Gave the clown two backpacks".
- Type git push origin give-clown-extra-backpack.
- Click https://github.com/Persistent-SS13/Persistent-Bay/compare/dev...rhicora:dev . Choose your fork as Head Fork from the dropdown, and right next to it, choose your new branch.
- Click the big green button to propose the code change!
Don't worry, it gets much faster after you do it a few times. If you get stuck, just @ an online Contributor in #code-discussion