Browse Source

Cleaned up instructions for wiki submission

Andrew Engelbrecht 6 years ago
parent
commit
22116df884
1 changed files with 40 additions and 25 deletions
  1. 40 25
      How To Submit A Change To This Wiki.md

+ 40 - 25
How To Submit A Change To This Wiki.md

@@ -1,40 +1,55 @@
 How To Submit A Change To This Wiki
-================================
+===================================
 
-Clone this repo and then:
--------------------------
+Clone this repo and:
+--------------------
 
-* git push
-* git request-pull -p
+    git clone https://gogs.librecmc.org/libreCMC/libreCMC-wiki.git
+
+then
+
+    git push
+
+or
+
+    git request-pull -p
 
 ### git push ( In Gogs )
 
 Clone the upstream repo in Gogs, then clone to your computer:
-> git clone https://yourUserName@yourURL
+
+    git clone https://yourUserName@yourURL
+
 Add upstream repo to be able to rebase to upstream point commit:
-> git remote add upstream https://gogs.librecmc.org/libreCMC/libreCMC-wiki.git
-> (git branch optionalBranchName)
-> git push (--all)
-Create Push Request in Gogs
+
+    git remote add upstream https://gogs.librecmc.org/libreCMC/libreCMC-wiki.git
+    (git checkout -b optionalBranchName)
+    git push (--all)
+
+Create Push Request in Gogs:
+
 * Press the little green PR button in your own repo
-or
-* Go here https://gogs.librecmc.org/libreCMC/libreCMC-wiki/pulls
+* Or go to <https://gogs.librecmc.org/libreCMC/libreCMC-wiki/pulls>
 
 ### git request-pull -p ( Anywhere )
 
-Clone the upstream repo to your computer
-> git add changedFile.md
-> git commit ( -m Short info what changed )
-> git log ( copy commit id )
-> git request-pull -p (start) URL (end)
-> git request-pull -p (commit in upstream repo) URL master
+Clone the upstream repo to your computer.
+
+    git add changedFile.md
+    git commit ( -m Short info what changed )
+    git log ( copy commit id )
+    git request-pull -p (start) URL (end)
+    git request-pull -p (commit in upstream repo) URL master
+
+Example for piping output to haste:
+
+    git request-pull -p b3b8926484feb37c33e5150facf315ef12b4612e https://gogs.librecmc.org/jonasbits2/libreCMC-wiki.git master | haste
+
+* Send to hastebin.com or any site you like
+* Paste link in IRC channel
 
-example pipe output to haste:
-> git request-pull -p b3b8926484feb37c33e5150facf315ef12b4612e https://gogs.librecmc.org/jonasbits2/libreCMC-wiki.git master | haste
+#### Links
 
-Send in a with hastebin.com or anything you like
-Paste link in IRC channel
+* <https://www.git-scm.com/docs/git-request-pull>
+* <https://hastebin.com/about.md>
 
-Links
-https://www.git-scm.com/docs/git-request-pull
-https://hastebin.com/about.md