From 2848a3e06c33507895b5227155f191663da073a3 Mon Sep 17 00:00:00 2001 From: tzarc Date: Sun, 1 Jan 2023 00:54:47 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20qmk/qmk?= =?UTF-8?q?=5Ffirmware@2ae215514a110f053b161420ec75d9f7953000d1=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- hardware_keyboard_guidelines.md | 2 ++ pr_checklist.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/hardware_keyboard_guidelines.md b/hardware_keyboard_guidelines.md index 6df86fb0fb9..338cc9e72b2 100644 --- a/hardware_keyboard_guidelines.md +++ b/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 ) and linking them in the `readme.md` is preferred. diff --git a/pr_checklist.md b/pr_checklist.md index 2f974c3817c..922cb19d9c3 100644 --- a/pr_checklist.md +++ b/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