diff options
| author | Drashna Jaelre <drashna@live.com> | 2022-07-12 20:50:26 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-12 20:50:26 -0700 |
| commit | 26954bbc2857c62d8de4522de12578c0da4cf904 (patch) | |
| tree | c1d90d236972898444be9a3bf079dc9ab05b7b80 | |
| parent | 2a3dd95229b68492e8740e1906957dad8ea38ea3 (diff) | |
[Docs] Add Encoder requirements to PR Checklist doc (#17634)
Co-authored-by: Nick Brassel <nick@tzarc.org>
| -rw-r--r-- | docs/pr_checklist.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index f55517dfa2..9ab8c80e9b 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -79,6 +79,9 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - `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) - prefer LED indicator [Configuration Options](feature_led_indicators.md?id=configuration-options) to custom `led_update_*()` implementations where possible + - Encoder support should not be hacked into the keymap here -- no `tap_code(dynamic_keymap_get_keycode())` or `action_exec()` hacks. The [Encoder Map](feature_encoders.md?id=encoder-map) feature already supports the dynamic keymap feature (what power's VIA's "live keymap updates" capability). + - If support is absolutely necessary, it should be implemented exclusively at the keymap level, with none of the implementation bleeding into the keyboard level (no empty rows/columns, no encoder specific layouts, etc.), as those configurations can be redefined at the keymap level. Keymaps can then choose to use the `action_exec` hack. <!-- because people will complain, give them a way to implement it, in the meanwhile. To be removed. --> + - [Request for official proper VIA support](https://github.com/the-via/app/issues/26) - `<keyboard>.h` - `#include "quantum.h"` appears at the top - `LAYOUT` macros should use standard definitions if applicable |