Skip to content

Commit 32ae776

Browse files
joelspadinpetejohanson
authored andcommittedApr 24, 2023
refactor: Add more checks to pre-commit
Updated existing pre-commit hooks and added some new hooks: - Remove trailing whitespace - Ensure every non-empty file ends with a new line - Check YAML file validity - Prevent adding large files - Ensure any scripts with shebangs are executable Added a GitHub action to run pre-commit on every commit. Removed any existing actions which duplicate pre-commit. Ran pre-commit on the codebase.
1 parent 9c4f1e0 commit 32ae776

File tree

247 files changed

+768
-806
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+768
-806
lines changed
 

‎.github/pull_request_template.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
<!-- If you're adding a board/shield please fill out this check-list, otherwise you can delete it -->
2+
23
## Board/Shield Check-list
3-
- [ ] This board/shield is tested working on real hardware
4-
- [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield))
5-
- [ ] `.zmk.yml` metadata file added
6-
- [ ] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
7-
- [ ] General consistent formatting of DeviceTree files
8-
- [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader))
9-
- [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable
10-
- [ ] If split, no name added for the right/peripheral half
11-
- [ ] Kconfig.defconfig file correctly wraps *all* configuration in conditional on the shield symbol
12-
- [ ] `.conf` file has optional extra features commented out
13-
- [ ] Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)
4+
5+
- [ ] This board/shield is tested working on real hardware
6+
- [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield))
7+
- [ ] `.zmk.yml` metadata file added
8+
- [ ] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
9+
- [ ] General consistent formatting of DeviceTree files
10+
- [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader))
11+
- [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable
12+
- [ ] If split, no name added for the right/peripheral half
13+
- [ ] Kconfig.defconfig file correctly wraps _all_ configuration in conditional on the shield symbol
14+
- [ ] `.conf` file has optional extra features commented out
15+
- [ ] Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)

‎.github/workflows/build-user-config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ on:
1919
required: false
2020
type: string
2121
archive_name:
22-
description: 'Archive output file name'
23-
default: 'firmware'
22+
description: "Archive output file name"
23+
default: "firmware"
2424
required: false
2525
type: string
2626

0 commit comments

Comments
 (0)