drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Add docs to cover recent LAYOUT_all lint checks (#19393)

Browse source
This commit is contained in:
Joel Challis 2023-01-01 00:53:10 +00:00 • committed by GitHub
parent b8e12eed80
commit 2ae215514a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/pr_checklist.md
View file

@ -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