Skip to content

Commit

Permalink
Merge pull request mumble-voip#4913: MAINT: Add CHANGE commit type
Browse files Browse the repository at this point in the history
This commit type is supposed to be used when e.g. a setting is changed.
  • Loading branch information
Krzmbrzl authored Apr 5, 2021
2 parents fbb2a8c + eabee58 commit 7e64683
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions COMMIT_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ The `TYPE` is one of the following:
| REFAC | Code refactoring | Rename variable `x` to `y` |
| BUILD | Changes related to the build process / buildsystem | Fix cmake script |
| TRANSLATION | Translation updates and changes | Update translation files |
| CHANGE | Something was changed without falling into existing categories | Changed the default of a setting |

The `TYPE` has to be in **all-uppercase** in order for it to stand out.

Expand Down
2 changes: 1 addition & 1 deletion scripts/commitMessage/CommitMessage.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def __init__(self, msg):
Exception(msg)

class CommitMessage:
knownTypes = ["BREAK", "FEAT", "FIX", "FORMAT", "DOCS", "TEST", "MAINT", "CI", "REFAC", "BUILD", "TRANSLATION"]
knownTypes = ["BREAK", "FEAT", "FIX", "FORMAT", "DOCS", "TEST", "MAINT", "CI", "REFAC", "BUILD", "TRANSLATION", "CHANGE"]

def __init__(self, commitString):
lines = commitString.strip().split("\n")
Expand Down
2 changes: 2 additions & 0 deletions scripts/generateChangelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ def main():
prefix = "Added: "
elif "FIX" in commit.m_types:
prefix = "Fixed: "
elif "CHANGED" in commit.m_types:
prefix = "Changed: "
else:
prefix = "Unknown: "

Expand Down

0 comments on commit 7e64683

Please sign in to comment.