summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-08-16 17:02:38 +0000
committerQMK Bot <hello@qmk.fm>2022-08-16 17:02:38 +0000
commitc5dc4b4d1de604b85ca833c9aff3fba8b83a64f9 (patch)
tree41fb19591b03ac23c6c3f7e2ce68e1a2ca6ca6ce /docs
parent9f0925fb1831f06d12d2e83f90199285bb09be4b (diff)
parent2f4ad4056194476a694b871961d8fc5b2fadcbbb (diff)
downloadqmk_firmware-c5dc4b4d1de604b85ca833c9aff3fba8b83a64f9.tar.gz
qmk_firmware-c5dc4b4d1de604b85ca833c9aff3fba8b83a64f9.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/pr_checklist.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
index 634ca4193a..ae5cb5eef6 100644
--- a/docs/pr_checklist.md
+++ b/docs/pr_checklist.md
@@ -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
- `info.json`
- - valid URL
- - valid maintainer
- - displays correctly in Configurator (press Ctrl+Shift+I to preview local file, turn on fast input to verify ordering)
+ - 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).
+ - the mandatory elements for a minimally complete `info.json` at present are:
+ - 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`
- 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