~ruther/qmk_firmware

ref: a40cccced29990eef5dac798d522c87807aa5e3a qmk_firmware/docs/newbs_git_best_practices.md -rw-r--r-- 961 bytes
a40cccce — Joel Challis Resolve some "Layout should not contain name of keyboard" lint warnings (#21898) 2 years ago

#Best Git Practices for Working with QMK

#Or, "How I Learned to Stop Worrying and Love Git."

This section aims to instruct novices in the best ways to have a smooth experience in contributing to QMK. We will walk through the process of contributing to QMK, detailing some ways to make this task easier, and then later we'll break some things in order to teach you how to fix them.

This section assumes a few things:

  1. You have a GitHub account, and have forked the qmk_firmware repository to your account.
  2. You've set up both your build environment and QMK.