Skip to content

How To Contribute (Command Line Version)

Rhicora edited this page Nov 4, 2018 · 1 revision

First steps: you'll only have to do these once, but be sure to do them exactly.

  1. Make a Github account: https://github.com/join
  2. 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.
  3. 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.
  4. 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.
  5. 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.
  6. Type cd Persistent-Bay to enter that directory. You may also want to have the same folders open in File Explorer for later.
  7. 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:

  1. Type git pull upstream dev to bring in the latest changes.
  2. 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.
  3. 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.
  4. 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.
  5. 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
  6. 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!
  7. Go back to your Command Prompt. Type git add . and git commit -m "Gave the clown two backpacks".
  8. Type git push origin give-clown-extra-backpack.
  9. Click https://github.com/Persistent-SS13/Persistent-Bay/compare/dev...rhicora:dev , then choose your fork as Head Fork and your new branch as its branch.
  10. 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 ping @Contributors in #code-discussion. We're happy to help you through.

Clone this wiki locally