fgardt
commented
1 year ago In GitLab by @Slartibartfass2 on Mar 4, 2023, 17:31
Conventional commits
feat
- new functionality added
fix
- fixes a bug
- this doesn't include fixing formatting because the pipeline failed (in this case
stylewould be the right choice)
docs
- documentation changes e.g. README, CHANGELOG, code documentation
- no code changes at all
style
- changing the style of the code e.g. formatting
- no additional functionality
- no refactoring
refactor
- refactoring the code e.g. splitting up a method into smaller methods, reducing redundance
- no additional functionality
perf
- performance improvement
test
- Adding or correcting tests
- no additional functionality or refactoring
- only test files are affected by this
build
- changes that affect the build system or external dependencies
- probably rare
ci
- changes at the pipeline e.g. adding coverage analysis or formatting check
- no changes at the code base
chore
- changes that don't affect the code base or tests
- "the commit to chose, when the rest doesn't fit"
revert
- reversion of previous commit(s)
In GitLab by @Merseleo on Jan 26, 2023, 12:55
What problem are you trying to solve?
Using some rare prefixes from the conventional commits prefixes leads to uncertainty. Additionally I used some in the wrong way, maybe as others. Therefor it would be helpful, if we document at some place, what the prefixes means for us.
Why should we solve it?
How do you propose to solve it?
What other approaches did you consider?
What could go wrong?
/cc @Slartibartfass2 @fgardt @mm1398 @Shiroen95