diff options
| author | Joel Challis <git@zvecr.com> | 2025-05-18 16:42:43 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-18 16:42:43 +0100 |
| commit | 02517bd8069ea6d22a3b10945611b0170f7ef7d4 (patch) | |
| tree | 7faddce3e7a81be9b0bcd78fe6a45f7800157848 /docs | |
| parent | 0f948fe039fd44d6237653316aafa6ba3d195b1d (diff) | |
Update PR checklist notes on custom matrix (#25240)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/pr_checklist.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 268e3b1b11..61119178bb 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md | |||
| @@ -127,7 +127,8 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard | |||
| 127 | - empty `xxxx_xxxx_kb()`, `xxxx_xxxx_user()`, or other weak-defined default implemented functions removed | 127 | - empty `xxxx_xxxx_kb()`, `xxxx_xxxx_user()`, or other weak-defined default implemented functions removed |
| 128 | - commented-out functions removed too | 128 | - commented-out functions removed too |
| 129 | - `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions#keyboard_pre_init_-function-documentation) | 129 | - `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions#keyboard_pre_init_-function-documentation) |
| 130 | - prefer `CUSTOM_MATRIX = lite` if custom matrix used, allows for standard debounce, see [custom matrix 'lite'](custom_matrix#lite) | 130 | - when configuring custom matrix, the 'lite' variant (`CUSTOM_MATRIX = lite`) must be used where possible, as this allows for standard debounce. See [custom matrix 'lite'](custom_matrix#lite) |
| 131 | - justification for full custom matrix (`CUSTOM_MATRIX = yes`) must be provided when used | ||
| 131 | - prefer LED indicator [Configuration Options](features/led_indicators#configuration-options) to custom `led_update_*()` implementations where possible | 132 | - prefer LED indicator [Configuration Options](features/led_indicators#configuration-options) to custom `led_update_*()` implementations where possible |
| 132 | - hardware that's enabled at the keyboard level and requires configuration such as OLED displays or encoders should have basic functionality implemented here | 133 | - hardware that's enabled at the keyboard level and requires configuration such as OLED displays or encoders should have basic functionality implemented here |
| 133 | - `<keyboard>.h` | 134 | - `<keyboard>.h` |
