diff options
| author | Ryan <fauxpark@gmail.com> | 2024-06-02 12:42:24 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-02 12:42:24 +1000 |
| commit | 78a0adfbb4d2c4e12f93f2a62ded0020d406243e (patch) | |
| tree | e6e123b36569559233025add654580e090dc0154 /docs/pr_checklist.md | |
| parent | fa6d23235bf429446250cd5212e209d5fbfdbac2 (diff) | |
[docs] Organize driver & feature docs into subfolders (#23848)
Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'docs/pr_checklist.md')
| -rw-r--r-- | docs/pr_checklist.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index e5ed1d67b6..f7b16e1d85 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md | |||
| @@ -126,7 +126,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard | |||
| 126 | - commented-out functions removed too | 126 | - commented-out functions removed too |
| 127 | - `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions#keyboard_pre_init_-function-documentation) | 127 | - `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions#keyboard_pre_init_-function-documentation) |
| 128 | - prefer `CUSTOM_MATRIX = lite` if custom matrix used, allows for standard debounce, see [custom matrix 'lite'](custom_matrix#lite) | 128 | - prefer `CUSTOM_MATRIX = lite` if custom matrix used, allows for standard debounce, see [custom matrix 'lite'](custom_matrix#lite) |
| 129 | - prefer LED indicator [Configuration Options](feature_led_indicators#configuration-options) to custom `led_update_*()` implementations where possible | 129 | - prefer LED indicator [Configuration Options](features/led_indicators#configuration-options) to custom `led_update_*()` implementations where possible |
| 130 | - hardware that's enabled at the keyboard level and requires configuration such as OLED displays or encoders should have basic functionality implemented here | 130 | - hardware that's enabled at the keyboard level and requires configuration such as OLED displays or encoders should have basic functionality implemented here |
| 131 | - `<keyboard>.h` | 131 | - `<keyboard>.h` |
| 132 | - `#include "quantum.h"` appears at the top | 132 | - `#include "quantum.h"` appears at the top |
| @@ -135,12 +135,12 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard | |||
| 135 | - no duplication of `rules.mk` or `config.h` from keyboard | 135 | - no duplication of `rules.mk` or `config.h` from keyboard |
| 136 | - `keymaps/default/keymap.c` | 136 | - `keymaps/default/keymap.c` |
| 137 | - `QMKBEST`/`QMKURL` example macros removed | 137 | - `QMKBEST`/`QMKURL` example macros removed |
| 138 | - if using `MO(1)` and `MO(2)` keycodes together to access a third layer, the [Tri Layer](feature_tri_layer) feature should be used, rather than manually implementing this using `layer_on/off()` and `update_tri_layer()` functions in the keymap's `process_record_user()`. | 138 | - if using `MO(1)` and `MO(2)` keycodes together to access a third layer, the [Tri Layer](features/tri_layer) feature should be used, rather than manually implementing this using `layer_on/off()` and `update_tri_layer()` functions in the keymap's `process_record_user()`. |
| 139 | - default (and via) keymaps should be "pristine" | 139 | - default (and via) keymaps should be "pristine" |
| 140 | - bare minimum to be used as a "clean slate" for another user to develop their own user-specific keymap | 140 | - bare minimum to be used as a "clean slate" for another user to develop their own user-specific keymap |
| 141 | - what does pristine mean? no custom keycodes. no advanced features like tap dance or macros. basic mod taps and home row mods would be acceptable where their use is necessary | 141 | - what does pristine mean? no custom keycodes. no advanced features like tap dance or macros. basic mod taps and home row mods would be acceptable where their use is necessary |
| 142 | - standard layouts preferred in these keymaps, if possible | 142 | - standard layouts preferred in these keymaps, if possible |
| 143 | - should use [encoder map feature](feature_encoders#encoder-map), rather than `encoder_update_user()` | 143 | - should use [encoder map feature](features/encoders#encoder-map), rather than `encoder_update_user()` |
| 144 | - default keymap should not enable VIA -- the VIA integration documentation requires a keymap called `via` | 144 | - default keymap should not enable VIA -- the VIA integration documentation requires a keymap called `via` |
| 145 | - submitters can add an example (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap | 145 | - submitters can add an example (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap |
| 146 | - submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board | 146 | - submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board |
