Documentation

 

Commit Description Rules

Internally, CRYENGINE requires every commit made to the engine to follow a specific formatting. The following table lists all prefixes we use when submitting changes and should help you when you are referring to the source code:

PrefixDescription
!ANew files added.

!D

Deleted files from the repository.
!B

Bugfix. this often includes the JIRA ticket ID corresponding to the bugfix. E.g., !B (Scaleform) (CE-5467) Fixed HUD updating slowly in medium & low spec

!FA new feature has been implemented.
!RThe code has been refactored.
!OOptimizations have been made.
!TTweaks or small parameter changes were made.

!I

Integration of files from/to a branch.

!E

This change is from an external contributor, e.g., !E David Kaye.
!X

This change will be excluded from the automated changelist generation. E.g., !XB (PS4) Release compilation.

  • The general format for commit descriptions we follow is: !Prefix (Component) (CE-5467) Fixed HUD updating slowly in medium & low spec.
  • Each "!" starts a new entry in the changelist, and so this is used to spread a description over multiple lines if necessary.
  • Combining prefixes is also possible. For example: !XBO (Component) Fixed a bug that should be hidden from the changelist, and by the way, it optimizes the engine. In this case, the first occurring letter will be preferred during changelist creation.
Crytek GmbH uses cookies on this website to improve your experience, analyze our traffic and integrate with social media. You may adjust cookie preferences by clicking “customize” or withdraw decision to accept or reject cookies at any time. Please find further information in our Privacy and Cookie policies.
Customize