[Docs] update pr_checklist.md with info about data-driven (#18068)
* update pr_checklist with info about data-driven Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
This commit is contained in:
parent
164faf0a5c
commit
2f4ad40561
@ -46,9 +46,12 @@ Closed PRs (for inspiration, previous sets of review comments will help you elim
|
|||||||
https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
|
https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
|
||||||
|
|
||||||
- `info.json`
|
- `info.json`
|
||||||
- valid URL
|
- With the move to [data driven](https://docs.qmk.fm/#/data_driven_config) keyboard configuration, we encourage contributors to utilise as many features as possible of the info.json [schema](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema).
|
||||||
- valid maintainer
|
- the mandatory elements for a minimally complete `info.json` at present are:
|
||||||
- displays correctly in Configurator (press Ctrl+Shift+I to preview local file, turn on fast input to verify ordering)
|
- valid URL
|
||||||
|
- valid maintainer
|
||||||
|
- valid USB VID/PID and device version
|
||||||
|
- displays correctly in Configurator (press Ctrl+Shift+I to preview local file, turn on fast input to verify ordering)
|
||||||
- `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
|
||||||
|
Loading…
Reference in New Issue
Block a user