Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] update pr_checklist.md with info about data-driven #18068

Merged

Conversation

keyboard-magpie
Copy link
Contributor

Description

Trying to improve PR checklist again. This time with DD info.

I'm flexible on the wording of the first line of the info.json part- appreciate feedback.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

I'm flexible on the wording of the first line of the info.json part- appreciate feedback.
@drashna drashna requested a review from a team August 15, 2022 18:39
docs/pr_checklist.md Outdated Show resolved Hide resolved
- 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that qmk info --layouts can also output a quick reference of it too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would you prefer that to be incorporated into the list?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@drashna,

Is the intention here just that the visual rendering is accurate, or the implementation as well?

I have very little confidence that this will improve the rate of proper Configurator implementations at PR creation time.

docs/pr_checklist.md Outdated Show resolved Hide resolved
@noroadsleft noroadsleft dismissed their stale review August 15, 2022 21:46

Flagged issue was resolved.

@keyboard-magpie keyboard-magpie merged commit 2f4ad40 into qmk:master Aug 16, 2022
@keyboard-magpie keyboard-magpie deleted the PR-checklist-DD-edits-interim branch August 16, 2022 17:02
imhoffman pushed a commit to imhoffman/qmk_firmware that referenced this pull request Aug 20, 2022
* update pr_checklist with info about data-driven

Co-authored-by: James Young <[email protected]>
SjB added a commit to SjB/qmk_firmware that referenced this pull request Aug 27, 2022
* upstream/master: (595 commits)
  [Keyboard] Add ibis80 (qmk#18051)
  [Keymap] toshi0383 keymaps update (qmk#18073)
  [Docs] Use layer number as example for COMBO_ONLY_FROM_LAYER (qmk#18072)
  [Keymap] jotix's community/ortho4x12 change (qmk#18069)
  Adjust the hierarchy of chapter `Deferred Execution` (qmk#18075)
  Fix WS2812 order for aurora65 and loki65 (qmk#18074)
  [Docs] update pr_checklist.md with info about data-driven (qmk#18068)
  Use correct board file in xelus/valor_frl_tkl/rev2_0 (qmk#18071)
  Migrate more F4x1 board files (qmk#18054)
  ADB to USB converter: split into rev1 and rev2 (qmk#18052)
  Move keyboard USB IDs and strings to data driven, pass 2: D-E (qmk#17956)
  Move keyboard USB IDs and strings to data driven, pass 2: F-I (qmk#17958)
  Allow disabling RGB_MATRIX_ANIMATIONS system76 keyboards (qmk#17478)
  Migrate more F4x1 board files (qmk#18046)
  Feat/port ft mars 65 (qmk#17994)
  Improve Drop Alt compatibility with VIA (qmk#18041)
  [Keyboard] Add Valor FRL TKL rev2.0 and 2.1 (qmk#17992)
  Move keyboard USB IDs and strings to data driven, pass 2: B-C (qmk#17945)
  [Keyboard] add bajjak keyboard (qmk#12377)
  Add texts for Discord Events to be created post-merge. (qmk#17944)
  ...
nolanseaton pushed a commit to nolanseaton/qmk_firmware that referenced this pull request Jan 23, 2023
* update pr_checklist with info about data-driven

Co-authored-by: James Young <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants