Loading...
 
Skip to main content
List of tags to be used in commit messages - used to generate changelog.txt
Type of page »  Developers documentation

Commit Tags

Commit messages may start with one or more of the tags listed at the top of changelog.txt to distinguish changes. See also Guidelines for intro page for each release.

Current tags table

Tag Description
[BP] Indicates a back-ported code from higher version (branch) of some sort (usually cherry-picks)
[DB] For any changes in the database
[DOC] For improvements in the tips or contextual documentation provided to the user/admin/developers
[ENH] A enhancement does not really add any feature, but makes things work better (e.g. look and feel, performance...)
[FIX] For bug fixes of any sort
[KIL] For removals of unused or obsolete files.
[MOD] It is a change which may be disruptive. For example, changing the default value of an option.
[MRG] For branch merges, generally performed by the merge scripts
[NEW] For commits adding a new feature on Tiki
[REF] For refactoring; changes the structure of the code (to make it cleaner or clearer), without changing its actual behaviour.
[REL] For the release process
[REM] For feature removals
[SEC] For security fix operations. If you feel you have reason to put this tag, please first contact security at tiki.org.
[TRA] For translation
[UI] For specific user interface (UI) improvements, referring to particular details of interactivity, look, and feel of the page elements and overall page
[UPD] For updates of third party/vendor libraries
[UX] For user experience improvements (more general than UI improvements) that make Tiki easier to understand and use (more details in https://dev.tiki.org/UX )


When you need to revert some commit manually (e.g., it was a part of more complex MR with squashed commits where reverting the whole MR is undesired) just make a new commit where you copy-paste the original commit message and prepend it with "Revert ".

Deprecated tags


SVN used to be used as Tiki code primary reference. Not any more.

[bp/rXXXX] Backport revision XXXX to current branch. Intended for committing a change already made in trunk to an earlier version. A backport reference should be added in front. For example, [bp/r61102][FIX] ... in a commit message to the branch branches/16x, means this fix is a backport of trunk revision 61102 to the next version of Tiki 16x. Depending on the period, backports are subject to an extra level of review so please read Quality Team and Where to commit first or ask on the dev mailing list or community chatroom if unsure.
[rb/rXXXXX] Revert changes made by revision XXXXX. For example, adding [rb/r61102] ... in a commit message to the branch branches/16x, means the change committed in revision 61102 are rolled back (removed, reverted) to the previous state, before r61102.

Related links