diff options
| author | Nick Winans <nick.win999@gmail.com> | 2021-10-03 22:29:59 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-03 23:29:59 -0400 |
| commit | 19a7d686fbb7ed1bc53444f1536a1cc2c5bd2d8d (patch) | |
| tree | b05d8e66d596da467dd434eba182be45f695d855 /.github/pull_request_template.md | |
| parent | 3b8244e4662c4f01f049c0d6ee1e2fa1c2de3779 (diff) | |
chore: Add board/shield checklist for new PRs.
Diffstat (limited to '.github/pull_request_template.md')
| -rw-r--r-- | .github/pull_request_template.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c191ccc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +<!-- If you're adding a board/shield please fill out this check-list, otherwise you can delete it --> +## Board/Shield Check-list + - [ ] This board/shield is tested working on real hardware + - [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield)) + - [ ] `.zmk.yml` metadata file added + - [ ] Proper Copyright + License headers added to applicable files + - [ ] General consistent formatting of DeviceTree files + - [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader)) + - [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable + - [ ] If split, no name added for the right/peripheral half + - [ ] `.conf` file has optional extra features commented out |