diff options
| author | QMK Bot <hello@qmk.fm> | 2022-01-23 22:15:53 +0000 |
|---|---|---|
| committer | QMK Bot <hello@qmk.fm> | 2022-01-23 22:15:53 +0000 |
| commit | 95321fbc2cbe81d853951d4f2e403698a5a72b3c (patch) | |
| tree | adc9364ead8605455ff587c7f1ffb196bedb05a3 /docs/pr_checklist.md | |
| parent | 77062e9a36b3167ea1ff747e5577a67969273c31 (diff) | |
| parent | 7d6e15423be8c34dd456cd2c057f50f5c3d0a70c (diff) | |
| download | qmk_firmware-95321fbc2cbe81d853951d4f2e403698a5a72b3c.tar.gz qmk_firmware-95321fbc2cbe81d853951d4f2e403698a5a72b3c.zip | |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/pr_checklist.md')
| -rw-r--r-- | docs/pr_checklist.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 25f3d7662e..1bd6200b82 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -110,6 +110,8 @@ Also, specific to ChibiOS: - a lot of the time, an equivalent Nucleo board can be used with a different flash size or slightly different model in the same family - example: For an STM32L082KZ, given the similarity to an STM32L073RZ, you can use `BOARD = ST_NUCLEO64_L073RZ` in rules.mk - QMK is migrating to not having custom board definitions if at all possible, due to the ongoing maintenance burden when upgrading ChibiOS +- New board definitions must not be embedded in a keyboard PR + - See _Core PRs_ below for the procedure for adding a new board to QMK - if a board definition is unavoidable, `board.c` must have a standard `__early_init()` (as per normal ChibiOS board defs) and an empty `boardInit()`: - see Arm/ChibiOS [early initialization](https://docs.qmk.fm/#/platformdev_chibios_earlyinit?id=board-init) - `__early_init()` should be replaced by either `early_hardware_init_pre()` or `early_hardware_init_post()` as appropriate @@ -118,7 +120,7 @@ Also, specific to ChibiOS: ## Core PRs - must now target `develop` branch, which will subsequently be merged back to `master` on the breaking changes timeline -- any support for new hardware now requires a corresponding test board under `keyboards/handwired/onekey` +- any new boards adding support for new hardware now requires a corresponding test board under `keyboards/handwired/onekey` - 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 |