How-to-Contribute/README.md

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