This document defines guidelines and conventions for writing commit messages in game development repositories. The main objective is to make the commit history organized and easy to read to facilitate collaboration between development teams and improve code optimization over time.
<scope (optional)> <type> - <title>
<description>
- PLAY: Used for versioning gameplay alterations.
- GUI: Used for creating, altering, or changing user interface elements.
- ENGINE: Used for backend changes, including code optimizations.
- TEST: Used for test alterations.
- RESOURCE (RESO): Used when adding a new resource or library to the project.
- DOCS: Used for upgrading documentation within the repository.
- CONFIG (CONF): Used for configuring project settings.
- DATAUPDATE (DATUP): Used for inserting data into the game.
- BUILD: Used for alterations to prepare for building the project.
Custom scopes can be added to modify the commit context. The default commit without a scope is considered a feature commit. Additional types include:
- FIX: Used for commits fixing a problem.
- STYLE: Used for reorganizing without fixing a problem.
- REFACT: Used for alterations aimed at optimizing the application.
Commits should be separated by type rather than combining changes into a single commit. Avoid unnecessary repetition in commit messages.
PLAY Player Movement - Add a sample script of the player’s movement.
GUI Main Menu - Create the main menu interface.
ENGINE Code Optimization - Improve performance by refactoring code.
TEST Enemy Behavior - Test enemy behavior in different scenarios.
RESOURCE Character Model - Add a new character model to the game.
DOCS Update README - Update the project's README file with new information.
CONFIG Audio Settings - Adjust audio settings for better sound quality.
DATAUPDATE Level Data - Insert level data into the game.
BUILD Version 1.0 - Prepare for the release of version 1.0.
credits: https://github.com/ayslan-gamedev