32ae776c42
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.2 KiB
1.2 KiB
Board/Shield Check-list
- This board/shield is tested working on real hardware
- Definitions follow the general style of other shields/boards upstream (Reference)
.zmk.ymlmetadata file added- 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)
- General consistent formatting of DeviceTree files
- Keymaps do not use deprecated key defines (Check using the upgrader tool)
&pro_microused in favor of&pro_micro_d/aif applicable- If split, no name added for the right/peripheral half
- Kconfig.defconfig file correctly wraps all configuration in conditional on the shield symbol
.conffile has optional extra features commented out- 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)