From 027d48bca2f14da8d691102d1ea17f96f5aa48f6 Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Wed, 20 Dec 2023 22:49:40 +0000 Subject: [PATCH 1/3] reword PR checklist for vendor keymaps/userspace changes --- 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..5f3499bc963f 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`. +- #include QMK_KEYBOARD_H preferred to including specific board files +- prefer layer enums to #defines +- custom keycode enums must have first entry = SAFE_RANGE +- terminating backslash (\) in lines of LAYOUT macro parameters is superfluous and should be removed - some care with spacing (e.g., alignment on commas or first char of keycodes) makes for a much nicer-looking keymap ## Keyboard PRs From 6e88e771d6e2808f19781693b4b58740622966f1 Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Wed, 20 Dec 2023 22:54:52 +0000 Subject: [PATCH 2/3] clarify vendor keymaps slightly --- docs/pr_checklist.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 5f3499bc963f..d20068e19b52 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -42,6 +42,7 @@ If there are any inconsistencies with these recommendations, you're best off [cr !> 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. - 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 From 7479883d83592745c068678bc95d392c05c2e11c Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Wed, 20 Dec 2023 22:56:23 +0000 Subject: [PATCH 3/3] delete layout macro related line --- docs/pr_checklist.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index d20068e19b52..6a0ae3159768 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -46,7 +46,6 @@ If there are any inconsistencies with these recommendations, you're best off [cr - #include QMK_KEYBOARD_H preferred to including specific board files - prefer layer enums to #defines - custom keycode enums must have first entry = SAFE_RANGE -- terminating backslash (\) in lines of LAYOUT macro parameters is superfluous and should be removed - some care with spacing (e.g., alignment on commas or first char of keycodes) makes for a much nicer-looking keymap ## Keyboard PRs