Standards

Commit Standards

Mainly applicable to programming and electrical, less so for mechanical.

Inspired by Conventional Commits (opens in a new tab) and ZMK (opens in a new tab)

<type>[optional scope]: <description>

Include [optional scope] if project becomes increasing large

Examples of `<type>`

 - Build
 - Chore
 - Ci
 - Docs
 - Feat
 - Fix
 - Perf
 - Refactor
 - Revert
 - Style
 - Test

Sample Commit Messages

Feat: Implemented RP2040 onto ESC V3

Chore: Bumped Python to newest version

Fix: Changed foo_var to int to match type

Contact Us Carrier