diff options
| author | Drashna Jaelre <drashna@live.com> | 2021-11-11 23:33:16 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-12 18:33:16 +1100 |
| commit | 7c2b2c81b53d055c66a15bd9ced92f548ca28ad6 (patch) | |
| tree | cee363f120d209c620377be74ba9870290b821c0 /docs/pr_checklist.md | |
| parent | a2baed0ebf9d31d32478d6e35cf0a6f501e3a677 (diff) | |
| download | qmk_firmware-7c2b2c81b53d055c66a15bd9ced92f548ca28ad6.tar.gz qmk_firmware-7c2b2c81b53d055c66a15bd9ced92f548ca28ad6.zip | |
[Docs] Codify not using code from other keyboards in PRs (#15128)
* [Docs] Codify not using code from other keyboards in PRs
* add additional comments
Diffstat (limited to 'docs/pr_checklist.md')
| -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 817ed22d41..94c62c6535 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -101,6 +101,9 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - submitters can have a personal (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap - submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board - Do not include VIA json files in the PR. These do not belong in the QMK repository as they are not used by QMK firmware -- they belong in the [VIA Keyboard Repo](https://github.com/the-via/keyboards) +- Do not include source files from another keyboard or vendors keyboard folder. Including core files is fine. + - For instance, only `wilba_tech` boards using be including `keyboards/wilba_tech/wt_main.c` and `keyboards/wilba_tech/wt_rgb_backlight.c`. But including `drivers/sensors/pmw3360.c` is absolutely fine. + - Code that needs to be used by multiple boards is a candidate for core code changes, and should be separated out. Also, specific to ChibiOS: - **strong** preference to using existing ChibiOS board definitions. |