diff options
| author | Tom Barnes <tom@mechboards.co.uk> | 2023-07-07 13:07:02 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-07 22:07:02 +1000 |
| commit | 3142f2dfdfc600e9164bbcd6f437c28e6bd1b624 (patch) | |
| tree | 407c486f1c63e6d64e7e5505e0ab61b6f988dd09 /docs | |
| parent | c610d4d95ab7d193142f0661937e6e493f187544 (diff) | |
clarify what the heck pristine means for reasons (#20950)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/pr_checklist.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 65584a9538..d22e912e86 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -132,6 +132,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - if using `MO(1)` and `MO(2)` keycodes together to access a third layer, the [Tri Layer](https://docs.qmk.fm/#/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()`. - default (and via) keymaps should be "pristine" - bare minimum to be used as a "clean slate" for another user to develop their own user-specific keymap + - 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 - standard layouts preferred in these keymaps, if possible - should use [encoder map feature](https://docs.qmk.fm/#/feature_encoders?id=encoder-map), rather than `encoder_update_user()` - default keymap should not enable VIA -- the VIA integration documentation requires a keymap called `via` |