|
|
@@ -39,7 +39,7 @@ 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.
|
|
|
|
|
|
- `#include QMK_KEYBOARD_H` preferred to including specific board files
|
|
|
- prefer layer `enum`s to `#define`s
|
|
|
@@ -103,7 +103,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
|
|
|
- keyboard `config.h`
|
|
|
- no `#define DESCRIPTION`
|
|
|
- no Magic Key Options, MIDI Options or HD44780 configuration
|
|
|
- - user preference configurable `#define`s need to be moved to keymap `config.h`
|
|
|
+ - user preference configurable `#define`s should not be placed at the keyboard level
|
|
|
- default values should not be redefined, such as `DEBOUNCE`, RGB related settings, etc.
|
|
|
- feature specific documentation contains most default values
|
|
|
- `grep` or alternative tool can be used to search for default values in core directories (e.g. `grep -r "define DEBOUNCE" quantum`)
|
|
|
@@ -117,8 +117,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
|
|
|
- mirroring existing functionality of a commercial board (like custom keycodes and special animations etc.) should be handled through non-`default` keymaps
|
|
|
- Vial-related files or changes will not be accepted, as they are not used by QMK firmware (no Vial-specific core code has been submitted or merged)
|
|
|
- `<keyboard>.c`
|
|
|
- - empty `xxxx_xxxx_kb()` or other weak-defined default implemented functions removed
|
|
|
- - empty `xxxx_xxxx_user()` or other user-level functions are disallowed at the keyboard level and must be moved to keymaps
|
|
|
+ - empty `xxxx_xxxx_kb()`, `xxxx_xxxx_user()`, or other weak-defined default implemented functions removed
|
|
|
- commented-out functions removed too
|
|
|
- `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions.md?id=keyboard_pre_init_-function-documentation)
|
|
|
- prefer `CUSTOM_MATRIX = lite` if custom matrix used, allows for standard debounce, see [custom matrix 'lite'](custom_matrix.md?id=lite)
|