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' %}
{% hint style='info' %}
This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system.
This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system.
{% endhint %}
{% 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.
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:
From there, click the "Clone or Download" button:
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]
**[terminal]
@ -53,12 +52,12 @@ To https://github.com/whoeveryouare/qmk_firmware.git
+ 20043e64...7da94ac5 master -> master
+ 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:
Jack Humbert
8 years ago