ci: Add gitlint and document commit conventions #2623
Conversation
petejohanson
commented
Nov 8, 2024
petejohanson
commented
- Add gitlint to pre-commit setup
- Update pre-commit setup for installing commit-hooks
- Add "Commit Conventions" contributing docs
petejohanson
added
the
github_actions
| - `feat:` - changes that add a new feature | ||
| - `fix:` - changes that fix existing functionality | ||
| - `refactor:` - changes that refactor existing functionality without adding any new features | ||
| - `feat!:`/`refactor!:`/`fix!` - same as above, but indicate a breaking change. |
There was a problem hiding this comment.
"Breaking change" might need elaboration here, e.g. as it relates to #2619. We can at least mention the easy ones for now, like board/shield changes or anything that affects user keymaps.
There was a problem hiding this comment.
Added a bit more context here. Thoughts?
| - `refactor:` - changes that refactor existing functionality without adding any new features | ||
| - `feat!:`/`refactor!:`/`fix!` - same as above, but indicate a breaking change. | ||
| - `ci:` - changes to our continuous integration setup with GitHub Actions, usually only for the files in `.github/workflows/`. | ||
| - `chore:` - grab bag type for small changes that don't fall into any of the above categories. |
There was a problem hiding this comment.
Do dependency updates for e.g. docs fall into docs or chore?
There was a problem hiding this comment.
IIRC, dependabot uses chore for this.
| - `split` - changes to our split keyboard support | ||
| - `studio` - changes to our ZMK Studio code | ||
| - `display` - changes to to our display code | ||
| - `underglow` - changes to to our RGB underglow support |
There was a problem hiding this comment.
Do we want lighting to cover backlight etc. as well?
There was a problem hiding this comment.
It'd be good to keep them distinct, IMHO, since there's already enough confusion generally about the two. IMHO, we should use backlight for this.
There was a problem hiding this comment.
Added a separate entry.
|
I believe this makes #586 redundant. |
petejohanson
force-pushed
the
chore/add-gitlint-integration
branch
from
01f0146 to
cef4e68
Compare
petejohanson
force-pushed
the
chore/add-gitlint-integration
branch
from
3978eeb to
6739e47
Compare
* Add gitlint to pre-commit setup * Update pre-commit setup for installing commit-hooks * Add "Commit Conventions" contributing docs Co-authored-by: Cem Aksoylar <[email protected]>
petejohanson
force-pushed
the
chore/add-gitlint-integration
branch
from
6739e47 to
915d767
Compare
