Skip to content

Commit

Permalink
[docs] - reword PR checklist for vendor keymaps/userspace changes (qm…
Browse files Browse the repository at this point in the history
…k#22725)

* reword PR checklist for vendor keymaps/userspace changes

* clarify vendor keymaps slightly

* delete layout macro related line
  • Loading branch information
keyboard-magpie authored and Nathan committed Feb 11, 2024
1 parent e164c8f commit bbfa28a
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/pr_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bbfa28a

Please sign in to comment.