From 092f19f5bc064dd34b87434b908a150f9b7a5bf7 Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Mon, 15 Aug 2022 19:09:58 +0100 Subject: [PATCH 1/3] update pr_checklist with info about data-driven I'm flexible on the wording of the first line of the info.json part- appreciate feedback. --- docs/pr_checklist.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 9ab8c80e9bed..e95b98209974 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -46,8 +46,10 @@ 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` + - 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 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) From 9e855c6617ebd45b613f70219f414e982442e418 Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Mon, 15 Aug 2022 20:12:13 +0100 Subject: [PATCH 2/3] formulate zv's suggestions --- docs/pr_checklist.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index e95b98209974..f8d5b373e69e 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -46,11 +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` - - 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 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) + - 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 From 82ea27e83bcd27a42d704d9fbd9fbf2c4aa9420b Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Mon, 15 Aug 2022 22:44:59 +0100 Subject: [PATCH 3/3] apply noroadsleft's suggestion Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> --- docs/pr_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index f8d5b373e69e..0a9eb58d048d 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -46,7 +46,7 @@ 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` - - 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). + - 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