Own take on "Semantic Commit Messages"

Clearer types with clearer descriptions

Format: <type>(<scope>): <subject>

<scope> is optional

Types

user here refers to anyone using the app.

- feat:

New feature for the user (nothing build related)

Adding a new toggle, new option, new page, etc...

- fix:

Bug fix for the user (nothing build related)

Segfault, 404, etc...

- docs:

Changes to the documentation

Markdown, docstrings, comments, etc...

If needed, I sometimes add [skip ci] at the end of the commit message to skip the CI as most documentation changes don't touch code.

- imp/style (improvement/styling):

Must be style-related

Formatting, missing semi colons, not respected coding style, etc...

- ref (refactor):

Improvements to code / rewrites

^ not to be confused with imp

Faster implementation, more readable (in the coding way, not styling), rewriting the system...

- test:

Test related

Unit tests added/removed, functional tests, etc...

- ci:

CI related

Jobs added/removed, scopes rewritten, etc...

- build:

Build related

Adding files to build, new variable to be set, new rule, etc...

- chore

"Other" tasks

Updating dependencies, removing an unused file, bumping version, etc...

---

Initial references:

• https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html