diff options
| author | Drashna Jaelre <drashna@live.com> | 2022-09-21 14:00:25 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-21 14:00:25 -0700 |
| commit | ea80141f6920c115bcf7993eb3173737a580e6d6 (patch) | |
| tree | d967a01399398f4ef94dcca212ce33b47b1ca7f2 /docs/pr_checklist.md | |
| parent | ee22f34e69abcd191b887d8dec7ae25655cc6cb4 (diff) | |
[Docs] Explicitly mention kb/user callbacks as boolean (#18448)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs/pr_checklist.md')
| -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 881f3f282c..6d74e246a8 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -135,6 +135,7 @@ Also, specific to ChibiOS: - for new MCUs, a new "child" keyboard should be added that targets your newly-added MCU, so that builds can be verified - for new hardware support such as display panels, core-side matrix implementations, or other peripherals, an associated keymap should be provided - if an existing keymap exists that can leverage this functionality this may not be required (e.g. a new RGB driver chip, supported by the `rgb` keymap) -- consult with the QMK Collaborators on Discord to determine if there is sufficient overlap already +- any features adding `_kb`/`_user` callbacks must return a `bool`, to allow for user override of keyboard-level callbacks. - other requirements are at the discretion of QMK collaborators - core is a lot more subjective given the breadth of posted changes |