summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2021-07-31 09:21:45 +1000
committerGitHub <noreply@github.com>2021-07-31 09:21:45 +1000
commitb459f314ec3e75d44aa6192bdbdf279041fe5c17 (patch)
treec37f48bb8c97e0ae1a0c2498ddbf89b031b5c11b /docs
parentaddb389a5e384f1db927610087c9258589b50f20 (diff)
Explicitly state that VIA should not be enabled in the default keymap. (#13803)
Diffstat (limited to 'docs')
-rw-r--r--docs/pr_checklist.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
index 9bfa79403d..c8e27d5658 100644
--- a/docs/pr_checklist.md
+++ b/docs/pr_checklist.md
@@ -93,6 +93,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
- default (and via) keymaps should be "pristine"
- bare minimum to be used as a "clean slate" for another user to develop their own user-specific keymap
- standard layouts preferred in these keymaps, if possible
+ - default keymap should not enable VIA -- the VIA integration documentation requires a keymap called `via`
- submitters can have a personal (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap
- submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board
- Do not include VIA json files in the PR. These do not belong in the QMK repository as they are not used by QMK firmware -- they belong in the [VIA Keyboard Repo](https://github.com/the-via/keyboards)