summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Barnes <tom@mechboards.co.uk>2022-08-16 18:01:56 +0100
committerGitHub <noreply@github.com>2022-08-16 18:01:56 +0100
commit2f4ad4056194476a694b871961d8fc5b2fadcbbb (patch)
tree72108ebf3613fa9e8ff4806dfc3f7b079bfa0035
parent164faf0a5c95e17bf913b1d2af088e6a2a0106c1 (diff)
[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>
-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