Commit Standards for This Project

To keep our project history clean, searchable, and easy to read, we follow the Conventional Commits specification.

This is a lightweight standard that adds a predictable prefix to your commit messages. Anyone scanning the history can instantly understand what kind of work was done.

Note

It is recommended you follow the source specification, as this section is merely a short introduction/cheatsheet.

A standard commit message looks like this:

type(optional-scope): short description

Here are the primary types you will use for this project:

• feat: A new feature, mechanic, or major asset addition (e.g., feat: add double jump to player character).

• fix: A bug fix, crash resolution, or visual correction (e.g., fix: resolve collision issue on bridge mesh).

• docs: Changes purely to documentation (e.g., docs: update the Git LFS instructions).

• chore: Routine tasks, project setting tweaks, or engine upgrades (e.g., chore: update project to Unreal 5.3).

Tip

Always write your description in the imperative (like giving an order to the engine). Use “fix lighting” instead of “fixed lighting” or “fixing lighting”.