ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify custom keycode enum requirement for PRs (#21648)

Browse source
This commit is contained in:
3geek14 2023-08-03 04:02:40 -04:00 • committed by GitHub
parent 19536b8190
commit aa8d1c5e07
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/pr_checklist.md
View file

@ -42,7 +42,7 @@ If there are any inconsistencies with these recommendations, you're best off [cr
- `#include QMK_KEYBOARD_H` preferred to including specific board files - `#include QMK_KEYBOARD_H` preferred to including specific board files
- prefer layer `enum`s to `#define`s - prefer layer `enum`s to `#define`s
- require custom keycode `enum`s to `#define`s, first entry must have ` = SAFE_RANGE` - custom keycode `enum`s must have first entry `= SAFE_RANGE`
- terminating backslash (`\`) in lines of LAYOUT macro parameters is superfluous and should be removed - 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 - some care with spacing (e.g., alignment on commas or first char of keycodes) makes for a much nicer-looking keymap