diff options
Diffstat (limited to 'docs/how_to_github.md')
| -rw-r--r-- | docs/how_to_github.md | 15 |
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 @@ # How to use Github with QMK +Github 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. + {% hint style='info' %} This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system. {% endhint %} @@ -8,9 +10,7 @@ Start on the [QMK Github page](https://github.com/qmk/qmk_firmware), and you'll  -If 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. - -From there, click the "Clone or Download" button: +If 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:  @@ -30,10 +30,9 @@ remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. Resolving deltas: 100% (29362/29362), done. Checking out files: 100% (2799/2799), done. -**[prompt you@computer]**[path ~]**[delimiter $ ] ``` -From 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: +You 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: ``` **[terminal] @@ -53,12 +52,12 @@ To https://github.com/whoeveryouare/qmk_firmware.git + 20043e64...7da94ac5 master -> master ``` -If you go back to your fork on Github, you can create a "New Pull Request" by clicking this button: +Your 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:  -From 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": +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":  -From 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 +After 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 |