From 5031e0e35c6c497b58b1f3122d8e9d17f0284733 Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Thu, 21 Dec 2023 12:30:55 +0000 Subject: [PATCH] [docs] - reword PR checklist for vendor keymaps/userspace changes (#22725) * reword PR checklist for vendor keymaps/userspace changes * clarify vendor keymaps slightly * delete layout macro related line --- docs/pr_checklist.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 0ca47933b5bb..6a0ae3159768 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -39,12 +39,13 @@ If there are any inconsistencies with these recommendations, you're best off [cr ## Keymap PRs -!> Note that personal keymap submissions will no longer be accepted. This section applies to manufacturer-supported keymaps. +!> Note that personal keymap submissions will no longer be accepted. This section applies to manufacturer-supported keymaps. Please see this [issue](https://github.com/qmk/qmk_firmware/issues/22724) for more information. -- `#include QMK_KEYBOARD_H` preferred to including specific board files -- prefer layer `enum`s to `#define`s -- custom keycode `enum`s must have first entry `= SAFE_RANGE` -- terminating backslash (`\`) in lines of LAYOUT macro parameters is superfluous and should be removed +- PRs for vendor specific keymaps will be permitted. The naming convention for these should be `default_${vendor}`, `via_${vendor}` i.e. `via_clueboard`. + - vendor specific keymaps do not necessarily need to be "vanilla" and can be more richly featured than `default` or `via` stock keymaps. +- #include QMK_KEYBOARD_H preferred to including specific board files +- prefer layer enums to #defines +- custom keycode enums must have first entry = SAFE_RANGE - some care with spacing (e.g., alignment on commas or first char of keycodes) makes for a much nicer-looking keymap ## Keyboard PRs