Add flag to commit to indicate, api break, default behavior change, ...
It would be good to normalize commits, so we can add semantic, like API break, default behavior change, ...
So when updating LVCore in an application, people know if this may cause some behavior changes, api break, ..., and can handle that.
We should add a document describing the normalization. This could be a git message template for example.
We need to define it.
Here is one example I use.
# [<tag>] (If applied, this commit will...) <subject> (Max 72 char)
# |<---- Preferably using up to 50 chars --->|<------------------->|
# Example:
# [feat] Implement automated commit messages
# (Optional) Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# (Optional) Provide links or keys to any relevant tickets, articles or other resources
# Example: Github issue #23
# --- COMMIT END ---
# Remember to:
# * Capitalize the subject line
# * Use the imperative mood in the subject line
# * Do not end the subject line with a period
# * Separate subject from body with a blank line
# * Use the body to explain what and why vs. how
# * Can use multiple lines with "-" or "*" for bullet points in body
# --------------------
# Tag can be
# feat (new feature)
# fix (bug fix)
# ci (change to ci scripts)
# refactor (refactoring code)
# style (formatting, missing semi colons, etc; no code change)
# doc (changes to documentation)
# test (adding or refactoring tests; no production code change)
# version (version bump/new release; no production code change)
# license (Edits regarding licensing; no production code change)
# hack (Temporary fix to make things move forward; please avoid it)
# perf (improve code performance)
# WIP (Work In Progress; for intermediate commits to keep patches reasonably sized)
# defaults (changes default options)
# submodules (update one or several submodules)
# --------------------
# Credit && Ressources:
# https://www.conventionalcommits.org/en/v1.0.0/#specification
# https://gitmoji.carloscuesta.me/
# https://gist.github.com/zakkak/7e06725ebd1336bfebebe254de3de825
Edited by MelanieCarriere