diff options
| author | Joel Challis <git@zvecr.com> | 2023-01-01 00:53:10 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-01 11:53:10 +1100 |
| commit | 2ae215514a110f053b161420ec75d9f7953000d1 (patch) | |
| tree | c2ae5d1563ef3b176e0bde17fbb1ecfc37e60980 | |
| parent | b8e12eed8038d172aacfd7381785643f2da9664c (diff) | |
Add docs to cover recent LAYOUT_all lint checks (#19393)
| -rw-r--r-- | docs/hardware_keyboard_guidelines.md | 2 | ||||
| -rw-r--r-- | docs/pr_checklist.md | 2 |
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index 6df86fb0fb..338cc9e72b 100644 --- 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 index 2f974c3817..922cb19d9c 100644 --- 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 |