diff options
author | Joel Challis <[email protected]> | 2023-01-01 00:53:10 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2023-01-01 11:53:10 +1100 |
commit | 2ae215514a110f053b161420ec75d9f7953000d1 (patch) | |
tree | c2ae5d1563ef3b176e0bde17fbb1ecfc37e60980 /docs/pr_checklist.md | |
parent | b8e12eed8038d172aacfd7381785643f2da9664c (diff) | |
download | qmk_firmware-2ae215514a110f053b161420ec75d9f7953000d1.tar.gz qmk_firmware-2ae215514a110f053b161420ec75d9f7953000d1.zip |
Add docs to cover recent LAYOUT_all lint checks (#19393)
Diffstat (limited to 'docs/pr_checklist.md')
-rw-r--r-- | docs/pr_checklist.md | 2 |
1 files changed, 2 insertions, 0 deletions
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 |