Skip to content

Conventional Commits

Conventional Commits

"The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history;"

Structure:

Text Only
1
2
3
4
5
<type>(<optional scope>): <description>
empty line as separator
<optional body>
empty line as separator
<optional footer>

This project's configuration file:

git-conventional-commits.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# https://github.com/qoomon/git-conventional-commits
---
convention:
  # commitMessageRegexPattern: ^(?<type>\w+)(?:\((?<scope>[^()]+)\))?(?<breaking>!)?:\s*(?<description>.+)
  commitTypes:
  - Feat     # Add a new feature
  - Fix      # A bug fix
  - Docs     # Affect documentation
  - Refactor # Rewrite/restructure code
  - Perf     # Special refactor that improve performance
  - Style    # White-space, formatting, missing semi-colons...
  - Test     # Add missing tests or correct existing
  - Chore    # Miscellaneous commits (e.g. modifying `.gitignore`)
  - Build    # Affect build components like build tool, ci pipeline, dependencies, project version...
  - CI       # Changes to CI configuration files and scripts
  - Remove   # Remove a feature
  - Revert   # Revert a removed feature / commit
  - Ops      # Affect operational components like infrastructure, deployment, backup, recovery, ...
  - Security # Improves project security
  commitScopes: [Deps, PR, UI, HUD, Input, Player, Combat, Inventory, AI, GOAP, NPC, Animation, Audio, VFX, SFX, Shaders, Rendering, Physics, Navigation, Level, World, Assets, Localization, Save, Networking, Tools, Editor, Addons, Docs, Tests, Build, CI]
  releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]*
changelog:
  commitTypes:
  - Feat
  - Fix
  - Perf
  includeInvalidCommits: true
  commitScopes: [Deps, PR, UI, HUD, Input, Player, Combat, Inventory, AI, GOAP, NPC, Animation, Audio, VFX, SFX, Shaders, Rendering, Physics, Navigation, Level, World, Assets, Localization, Save, Networking, Tools, Editor, Addons, Docs, Tests, Build, CI]
  commitIgnoreRegexPattern: "^WIP "
  headlines:
    Feat: Features
    Fix: Bug Fixes
    Perf: Performance Improvements
    Remove: Removes
    BreakingChange: BREAKING CHANGES
  commitUrl: https://github.com/Leonardo-Ma/Untitled-Platformer/commit/%commit%
  commitRangeUrl: https://github.com/Leonardo-Ma/Untitled-Platformer/compare/%from%...%to%?diff=split
  issueRegexPattern: "#[0-9]+"
  issueUrl: https://github.com/Leonardo-Ma/Untitled-Platformer/issues/%issue%