g1smo
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[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
master
Tom Barnes 2023-12-21 12:30:55 +00:00 committed by GitHub
parent 2661ee282a
commit 5031e0e35c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/pr_checklist.md
View File

@ -39,12 +39,13 @@ If there are any inconsistencies with these recommendations, you're best off [cr
## Keymap PRs ## 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 - PRs for vendor specific keymaps will be permitted. The naming convention for these should be `default_${vendor}`, `via_${vendor}` i.e. `via_clueboard`.
- prefer layer `enum`s to `#define`s - vendor specific keymaps do not necessarily need to be "vanilla" and can be more richly featured than `default` or `via` stock keymaps.
- custom keycode `enum`s must have first entry `= SAFE_RANGE` - #include QMK_KEYBOARD_H preferred to including specific board files
- terminating backslash (`\`) in lines of LAYOUT macro parameters is superfluous and should be removed - 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 - some care with spacing (e.g., alignment on commas or first char of keycodes) makes for a much nicer-looking keymap
## Keyboard PRs ## Keyboard PRs