auri.ee
keyboard stuff
1# How to Use GitHub with QMK
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
5::: tip
6This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system.
7:::
8
9Start on the [QMK GitHub page](https://github.com/qmk/qmk_firmware), and you'll see a button in the upper right that says "Fork":
10
11
12
13If you're a part 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:
14
15
16
17And be sure to select "HTTPS", and select the link and copy it:
18
19
20
21From here, enter `git clone --recurse-submodules ` into the command line, and then paste your link:
22
23```
24user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git
25Cloning into 'qmk_firmware'...
26remote: Enumerating objects: 9, done.
27remote: Counting objects: 100% (9/9), done.
28remote: Compressing objects: 100% (5/5), done.
29remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874
30Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done.
31Resolving deltas: 100% (119972/119972), done.
32...
33Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b'
34Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486'
35Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780'
36Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d'
37```
38
39You 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:
40
41```
42user@computer:~$ git add .
43user@computer:~$ git commit -m "adding my keymap"
44[master cccb1608] adding my keymap
45 1 file changed, 1 insertion(+)
46 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
47user@computer:~$ git push
48Counting objects: 1, done.
49Delta compression using up to 4 threads.
50Compressing objects: 100% (1/1), done.
51Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
52Total 1 (delta 1), reused 0 (delta 0)
53remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
54To https://github.com/whoeveryouare/qmk_firmware.git
55 + 20043e64...7da94ac5 master -> master
56```
57
58Your 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:
59
60
61
62Here 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":
63
64
65
66After submitting, we may talk to you about your changes, ask that you make changes, and eventually accept it! Thanks for contributing to QMK :)