Loading...
 
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.

Current tags table

Tag Description
[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. This tag was used in the sense of REM prior to Tiki 6.
[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
[UPD] For updates of third party/vendor libraries
[UX] For user experience improvements. It makes Tiki easier to use and understand (more details in https://dev.tiki.org/UX )
[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 mailing list or IRC 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.

Proposals

Subtags

To allow a lower number of (root) tags while increasing tagging precision, introducing the concept of subtags was proposed. A subtag has a parent which it implies. For example, [SEC] would become [FIX:SEC], a subtag of [FIX]. For more details, see https://sourceforge.net/p/tikiwiki/mailman/message/35757263/

SupportersOpponents
Chealer (proponent) Jyhem 2017-07-18
luciash
lindon 2017-07-18
Gary 2017-07-18

Tag removals/demotions

UX

Discussion

I do not understand when this tag can be better than [ENH], and it is quite subjective.

It's allowed after branching, when [ENH] is to be avoided. UX is often not dealt with until eveybody knows the feature has stopped being developped. So it's important that ENH stops when people try out features and improve UX. UX was introduced because there was never a correct time for improving UX, and lots of places looked unprofessional in official releases.

  • Whether a commits respects the rules depends on its content, not on its message. I do not understand why you state that "there was never a correct time for improving UX". "UX" can be improved at any time.


I think it is just the contrary. ;-) While UX, TRA or DOC says what they are about, ENH tend to mean and is use for anything that IMProve Tiki which. We should keep UX or if we remove it in favour of ENH then we should remove a few of others.

Consultation

Contributor SupportersOpponents
Chealer (proponent) Elimination (strong preference)
Bsfez Bsfez 2019-02-26

REM

Discussion

This can be replaced by [MOD].

Consultation

Contributor Preference
Chealer (proponent) Demote to sub-tag, failing that small preference for elimination

KIL

Discussion

This can be replaced by [REF], and I do not understand when [KIL] would be more useful. Moreover, there are frequent misuses because this tag was used in the sense of [REM] for years.

Consultation

Contributor Preference
Chealer (proponent) Elimination (strong preference)

Renamings

MOD

Discussion

The name "MOD" (surely "modification") is very vague. All commits are modifications. This tag is probably the one which is misused most often. Can we find a better name, such as [REG] ("regression")?

Consultation

Contributor Preference
Chealer (proponent) Rename to "REG" or other name (strong preference)

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools