commit 2ae215514a110f053b161420ec75d9f7953000d1
parent b8e12eed8038d172aacfd7381785643f2da9664c
Author: Joel Challis <git@zvecr.com>
Date: Sun, 1 Jan 2023 00:53:10 +0000
Add docs to cover recent LAYOUT_all lint checks (#19393)
Diffstat:
2 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
@@ -208,6 +208,8 @@ As an example, if you have a 60% PCB that supports ANSI and ISO you might define
| LAYOUT_ansi | default_ansi | An ANSI layout |
| LAYOUT_iso | default_iso | An ISO layout |
+?> Providing only `LAYOUT_all` is invalid - especially when implementing the additional layouts within 3rd party tooling.
+
## Image/Hardware Files
In an effort to keep the repo size down we're no longer accepting binary files of any format, with few exceptions. Hosting them elsewhere (such as <https://imgur.com>) and linking them in the `readme.md` is preferred.
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
@@ -55,6 +55,8 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
- `layout` definitions should include matrix positions, so that `LAYOUT` macros can be generated at build time
- should use standard definitions if applicable
- use the Community Layout macro names where they apply (preferred above `LAYOUT`/`LAYOUT_all`)
+ - use of `LAYOUT_all` is only valid when providing additional layout macros
+ - providing only `LAYOUT_all` is invalid - especially when implementing the additional layouts within 3rd party tooling
- `readme.md`
- standard template should be present -- [link to template](https://github.com/qmk/qmk_firmware/blob/master/data/templates/keyboard/readme.md)
- flash command is present, and has `:flash` at end
