From 33c453d771a89a5c050a512599422a308be62a37 Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Tue, 23 Apr 2024 19:38:08 +1000 Subject: [PATCH] PR Checklist: explain wireless requirements. (#23584) --- docs/pr_checklist.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 0d503ab4177..94ff7eed665 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -148,6 +148,13 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - For instance, only `wilba_tech` boards shall include `keyboards/wilba_tech/wt_main.c` and `keyboards/wilba_tech/wt_rgb_backlight.c`. But including `drivers/sensors/pmw3360.c` is absolutely fine for any and all boards that require it. - Code that needs to be used by multiple boards is a candidate for core code changes, and should be separated out. +Wireless-capable boards: +- Given license abuse from vendors, QMK does not accept any vendor PRs for wireless- or Bluetooth-capable keyboards without wireless and/or Bluetooth code + - Historically, vendors have done this in bad faith in order to attain downstream VIA compatibility with no intention of releasing wireless sources + - QMK's license, the GPL2+, requires full source disclosure for any distributed binary -- including full sources for any keyboard shipped by vendors containing QMK and/or firmware-side VIA code + - If a vendor's wireless-capable keyboard PR submission is lacking wireless capability, then the PR will be left on-hold and unmergeable until wireless bindings are provided + - If a vendor's wireless-capable keyboard is merged into QMK before it's known that the board is wireless, then all existing and future PRs from the same vendor will be put on hold until wireless bindings for the offending keyboard are provided + Also, specific to ChibiOS: - **strong** preference to using existing ChibiOS board definitions. - 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