How-to-Contribute/README.md

   1 How to Contribute to the GitGud
   2 =======================================================================
   3
   4 ## Contents
   5
   6 1. [Make an account](#how-to-quickly-make-an-account)
   7 2. [Using the Web Editor](#web-editor)
   8 3. [Setup SSH keys](#ssh-keys)
   9 4. [Fork and make changes to your repository](#fork-the-repository)
  10 5. [Merge your changes](#merge-your-changes)
  11 6. [Keep your repository updated](#how-to-update-your-copy)
  12 7. [Open issues and contribute to existing issues](#open-issues-and-contribute-to-existing-issues)
  13
  14 ![Image: Iwantyou](http://a.pomf.se/usysfm.jpg)
  15
  16 ### [\[⇧\]](#contents) How to quickly make an account
  17
  18 Go to [gitgud.net](http://gitgud.net/users/sign_in) and [sign up](http://gitgud.net/users/sign_up).
  19 Try to use an email address you'll be able to check for updates with. For example [cock.li](http://cock.li/register.php) is one such provider.
  20
  21
  22 ### [\[⇧\]](#contents) Web Editor
  23
  24 #### First, fork the repostory
  25
  26 ![Image: Step1](http://a.pomf.se/wcndqs.png)
  27
  28 #### Next, select Files
  29
  30 ![Image: step2](http://a.pomf.se/rlhmva.png)
  31
  32 #### Click the file you want to change then press edit
  33
  34 ![Image: step3](http://a.pomf.se/cvymsh.png)
  35
  36 #### Make your changes then write a short description of what you did, then save it with commit
  37
  38 ![Image: step4](http://a.pomf.se/znweiy.png)
  39
  40 #### Once done, click merge requests
  41
  42 ![Image: step5](http://a.pomf.se/tueilg.png)
  43
  44 #### Select new merge requests
  45
  46 ![Image: step6](http://a.pomf.se/vexkvo.png)
  47
  48 #### Then click master from the drop down (or whichever branch you made changes on) and then click compare branches and submit your merge for review.
  49
  50 ![Image: step7](http://a.pomf.se/vjdlnb.png)
  51
  52
  53 ## [\[⇧\]](#contents) Advanced
  54
  55 If you don't want to use the web editor and are comfortable with git see below!
  56
  57 ### [\[⇧\]](#contents) SSH Keys
  58
  59 If you've never used ssh or something similar to gitgud before, you'll
  60 need to setup your ssh keys. Our old friend Github has the best guide
  61 for this, [check it here](https://help.github.com/articles/generating-ssh-keys/)
  62 and just ignore the last part about testing it out.
  63
  64 ### [\[⇧\]](#contents) Fork the repository
  65
  66 ![Image: forking](http://a.pomf.se/cilxve.png)
  67
  68 In the top right of the [GamerGate Repository](http://gitgud.net/gamergate/gamergateop)
  69 you'll see a fork button, click that to make your own copy of the repository
  70 on your account. You can then use git to pull down your repository over HTTP
  71 and make your changes.
  72
  73 You'll also want to setup an _upstream_ remote pointing to this one by running
  74 the following command:
  75
  76     git remote add upstream http://gitgud.net/gamergate/gamergateop.git
  77
  78 then you can get the latest by running
  79
  80     git pull upstream master
  81
  82 at any time.
  83
  84
  85 ### [\[⇧\]](#contents) Merge Requests
  86
  87 Once you've worked on something, you'll want to [make a merge request](http://gitgud.net/gamergate/gamergateop/merge_requests)
  88 to the master branch of the main repository. You can assign it to any of the
  89 people who have access to the repository and the pull request will be reviewed.
  90
  91 **Please do not be discouraged if we ask you to change something**, we try
  92 very hard to keep the information in the repo up to date and factually
  93 accurate. Also, if any requests imply harassment or any of the other
  94 bullshit the mainstream media tries to paint us with, we'll ask for it
  95 to be changed. While we **all** know \#GamerGate is not about that, we
  96 can still try to nip any potential complaints in the bud.
  97
  98
  99 ### [\[⇧\]](#contents) How to Update your copy
 100
 101 You'll want to keep the latest and most up to date information on your
 102 repository, this means pulling and merging the code from the main repository
 103 into your own local and remote versions. This is as easy as adding the
 104 remote [(see above)](#fork-the-repository) and then running
 105
 106     git pull upstream master
 107
 108 ### [\[⇧\]](#contents) Open issues and contribute to existing issues
 109
 110 You can check out the [open issues here](http://gitgud.net/gamergate/gamergateop/issues)
 111 if you see one you think you can take on, please do! Many improvements to the
 112 repository can be done by anyone, such as crossing out sponsors who have
 113 withdrawn support, updating news links, adding archive links and more. All
 114 you really need to know how to do is write some markdown, and even if you
 115 don't, an examination of the source code of the repository will help inform
 116 you how to write it.
 117
 118 Even if you can't write in markdown and just want to contribute plain txt, we
 119 can always take it and make it shiny later. Information and knowledge don't
 120 need to be pretty to be accepted, it just has to be factual.
 121
 122 If you don't want to go through all this trouble you can still talk to us
 123 in irc on Rizon in the \#4free channel! Or reach out to us on [twitter!](http://twitter.com/gitgudgg)
 124
 125 ![Image: salute](http://a.pomf.se/spkxaj.jpg)
 126
 127 [Gater salute and I want you source](https://twitter.com/G4M3RG8R/status/522619436486758400)