darkkirb/qmk_firmware
1
0
Fork 0
forked from mirrors/qmk_firmware
Code Issues Pull requests Projects Releases Packages Wiki Activity

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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/hardware_keyboard_guidelines.md
View file

@ -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_ansi | default_ansi | An ANSI layout |
| LAYOUT_iso | default_iso | An ISO 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 ## 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. 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.

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 - `layout` definitions should include matrix positions, so that `LAYOUT` macros can be generated at build time
- should use standard definitions if applicable - should use standard definitions if applicable
- use the Community Layout macro names where they apply (preferred above `LAYOUT`/`LAYOUT_all`) - 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` - `readme.md`
- standard template should be present -- [link to template](https://github.com/qmk/qmk_firmware/blob/master/data/templates/keyboard/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 - flash command is present, and has `:flash` at end