aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-04-20 18:13:34 +0000
committerQMK Bot <hello@qmk.fm>2021-04-20 18:13:34 +0000
commit15872bde615ecf694e8bfd6e939a4f73ef4d4d1f (patch)
treed4dcb5f9981120c12634c76f6e8d2c12737724c1
parentb09d068bf6f33f8dee84f8125fee3b982f5f7def (diff)
parent6b5e349d7e3c3684c1baa543972dd0504217c7ba (diff)
downloadqmk_firmware-15872bde615ecf694e8bfd6e939a4f73ef4d4d1f.tar.gz
qmk_firmware-15872bde615ecf694e8bfd6e939a4f73ef4d4d1f.zip
Merge remote-tracking branch 'origin/master' into develop
-rw-r--r--docs/pr_checklist.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
index e0dd0770c..58df15303 100644
--- a/docs/pr_checklist.md
+++ b/docs/pr_checklist.md
@@ -68,6 +68,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
68 - bare minimum required code for a board to boot into QMK should be present 68 - bare minimum required code for a board to boot into QMK should be present
69 - initialisation code for the matrix and critical devices 69 - initialisation code for the matrix and critical devices
70 - mirroring existing functionality of a commercial board (like custom keycodes and special animations etc.) should be handled through non-`default` keymaps 70 - mirroring existing functionality of a commercial board (like custom keycodes and special animations etc.) should be handled through non-`default` keymaps
71 - VIAL-related files or changes will not be accepted, as they are not used by QMK firmware (no VIAL-specific core code has been submitted or merged)
71- `keyboard.c` 72- `keyboard.c`
72 - empty `xxxx_xxxx_kb()` or other weak-defined default implemented functions removed 73 - empty `xxxx_xxxx_kb()` or other weak-defined default implemented functions removed
73 - commented-out functions removed too 74 - commented-out functions removed too
@@ -94,6 +95,8 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
94 - standard layouts preferred in these keymaps, if possible 95 - standard layouts preferred in these keymaps, if possible
95- submitters can have a personal (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap 96- submitters can have a personal (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap
96- submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board 97- submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board
98- Do not include VIA json files in the PR. These do not belong in the QMK repository as they are not used by QMK firmware -- they belong in the [VIA Keyboard Repo](https://github.com/the-via/keyboards)
99
97 100
98Also, specific to ChibiOS: 101Also, specific to ChibiOS:
99- **strong** preference to using existing ChibiOS board definitions. 102- **strong** preference to using existing ChibiOS board definitions.
@@ -127,3 +130,9 @@ There are instructions on how to keep your fork updated here:
127 130
128Thanks for contributing! 131Thanks for contributing!
129``` 132```
133
134## Review Process
135
136In general, we want to see two (or more) approvals that are meaningful (e.g. that have inspected code) before a PR will be considered for merge. These reviews are not limited to collaborators -- any community member willing to put in the time is welcomed (and encouraged). The only difference is that your checkmark won't be green, and that's fine!
137
138Additionally, PR reviews are something that is done in our free time. We are not paid nor compensated for the time we spend reviewing, as it is a labor of love. As such, this means that it can take time for us to get to your Pull Request. Things like family, or life can get in the way of us getting to PRs, and burnout is a serious concern. The QMK firmware repository averages 200 PRs opened and 200 PRs merged every month, so please have patience.