aboutsummaryrefslogtreecommitdiff
path: root/docs/how_to_github.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-06-29 21:23:20 -0400
committerJack Humbert <jack.humb@gmail.com>2017-06-29 21:23:20 -0400
commit9f643ba8bf8bf8f187af1e33f4435e7b4f7ae0f5 (patch)
tree711b4c5f7b35e6e943a1493f6cee70d0fed32a2c /docs/how_to_github.md
parent4c7e66c31c345a258be538594a688e187d09419b (diff)
downloadqmk_firmware-9f643ba8bf8bf8f187af1e33f4435e7b4f7ae0f5.tar.gz
qmk_firmware-9f643ba8bf8bf8f187af1e33f4435e7b4f7ae0f5.zip
clean-up github page
Diffstat (limited to 'docs/how_to_github.md')
-rw-r--r--docs/how_to_github.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/how_to_github.md b/docs/how_to_github.md
index 2f3da42fd..387ddd91e 100644
--- a/docs/how_to_github.md
+++ b/docs/how_to_github.md
@@ -1,5 +1,7 @@
1# How to use Github with QMK 1# How to use Github with QMK
2 2
3Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK.
4
3{% hint style='info' %} 5{% hint style='info' %}
4This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system. 6This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system.
5{% endhint %} 7{% endhint %}
@@ -8,9 +10,7 @@ Start on the [QMK Github page](https://github.com/qmk/qmk_firmware), and you'll
8 10
9![Fork on Github](http://i.imgur.com/8Toomz4.jpg) 11![Fork on Github](http://i.imgur.com/8Toomz4.jpg)
10 12
11If you're apart of an organization, you'll need to choose which account to fork it to. In most circumstances, you'll want to fork it to your personal account. 13If you're apart of an organization, you'll need to choose which account to fork it to. In most circumstances, you'll want to fork it to your personal account. Once your fork is completed (sometimes this takes a little while), click the "Clone or Download" button:
12
13From there, click the "Clone or Download" button:
14 14
15![Download from Github](http://i.imgur.com/N1NYcSz.jpg) 15![Download from Github](http://i.imgur.com/N1NYcSz.jpg)
16 16
@@ -30,10 +30,9 @@ remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623
30Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. 30Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done.
31Resolving deltas: 100% (29362/29362), done. 31Resolving deltas: 100% (29362/29362), done.
32Checking out files: 100% (2799/2799), done. 32Checking out files: 100% (2799/2799), done.
33**[prompt you@computer]**[path ~]**[delimiter $ ]
34``` 33```
35 34
36From here, you can add your keymap, compile it and flash it to your board. Once you're happy with your changes, you can add, commit, and push them to your fork like this: 35You now have your QMK fork on your local machine, and you can add your keymap, compile it and flash it to your board. Once you're happy with your changes, you can add, commit, and push them to your fork like this:
37 36
38``` 37```
39**[terminal] 38**[terminal]
@@ -53,12 +52,12 @@ To https://github.com/whoeveryouare/qmk_firmware.git
53 + 20043e64...7da94ac5 master -> master 52 + 20043e64...7da94ac5 master -> master
54``` 53```
55 54
56If you go back to your fork on Github, you can create a "New Pull Request" by clicking this button: 55Your changes now exist on your fork on Github - if you go back there (https://github.com/<whoeveryouare>/qmk_firmware), you can create a "New Pull Request" by clicking this button:
57 56
58![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg) 57![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg)
59 58
60From here, you'll be able to see exactly what you've committed - if it all looks good, you can finalize it by clicking "Create Pull Request": 59Here you'll be able to see exactly what you've committed - if it all looks good, you can finalize it by clicking "Create Pull Request":
61 60
62![Create Pull Request](http://i.imgur.com/Ojydlaj.jpg) 61![Create Pull Request](http://i.imgur.com/Ojydlaj.jpg)
63 62
64From here, we may talk to you about your changes, ask that you make changes as we see fit, and eventually accept it! Thanks for contributing to QMK :) \ No newline at end of file 63After submitting, we may talk to you about your changes, ask that you make changes, and eventually accept it! Thanks for contributing to QMK :) \ No newline at end of file