Loading...
 
Where to commit? Type of page »  Developers documentation

Where to commit

Once you have read up on how to commit code, a very important decision is where to commit? Stable-LTS, Stable, Dev (trunk on SVN / master on Git), or experimental? You may want to checkout the Versions page. See also: Freeze and Slush and Git and SVN Combined Workflow

Dashboard

Quick overview intended to help to know where to commit to right now in most situations. See Branches section below for more detailed explanations.

Current status
* Automatic merging is ongoing (a.k.a. Semi-automatic merging period)
    • All fixes and translations to go into 19.x first, any enhancements need to go in trunk/master
    • For example if you want to make a fix to 12.x LTS, please commit the fix to 19.x first then backport to 18.x, and then to 15.x and finally to 12.x. For more details, see the table below.
    • During this period, changes to trunk/master increase the risks of merge conflicts. To minimize this risk, non-functional changes (e.g. code formatting, code documentation and other refactoring) which are not specific to trunk/master only and which can be postponed should be avoided. In particular, automated code reformatting in batch (many files at once) should be postponed.
  • Upcoming releases:
    • 19.0, 18.3 LTS, 15.8 LTS and 12.15 LTS will be the next versions released.


Commit status and order for each open branch:

I want to commit to: What is allowed: Commit first to: Afterwards , backport to:
trunk/master (future 20x) Functional enhancements, new features Nothing else
19x Fixes and translations only 18.x
18x Safe minor enhancements, fixes and translations 19.x 15.x
15x Fixes only LTS 18.x 12.x
12x Critical fixes only LTS 15.x


The other branches are closed, and no releases are planned. So there is no point in committing there.

Branches


Root: https://svn.code.sf.net/p/tikiwiki/code/

NameBRANCHComments
Devtrunk/master(will become 20.x branch in future) Most development (new features) happens here. New features, need to be functional, but don't need to be complete. In theory, should be releasable at any time. This is the place for refactoring. Cosmetic code changes should be done here after the Semi-automatic merging period has ended. Also: Update language stringsIf you must change the English version (but are not changing the meaning and so the translations are still valid, please use mass spelling correction. If you can't use that, just add to pending text corrections.. If you commit to trunk/master, and after you want to commit to a stable branch, please see how to merge a commit from trunk/master.
Stablebranches/19.x Fixes only until after 19.0 Auto-merge to trunk/master.
Stable LTSbranches/18.x Minor (and safe) enhancements and fixes. Backport from 19.x
Stable LTSbranches/15.x Security and bug fixes. Backport from 18.x.
Previous Stable LTSbranches/12.xOnly security fixes and translations. Backport from 15.x.
Experimental branchesmanyAll developments for things that are not stable enough yet or just intended as proof of concept before the real work starts. These branches will never become a released branch directly, the author of the experimental branch must move the functionality in the Dev branch when it's ready.

Definition of "security-only" phase

  • The "security-only" of the LTS period is intended for security fixes, but could include a few bug fixes as well.
    • We will review security vulnerabilities reported to the Security Team
    • Publish a fix or a way to deactivate the feature.
      • If the included code doesn't have a patch for that version
  • What if a security vulnerability requires major code changes, that are not suitable for LTS?
    • We'll disable the feature via System Configuration so you can can choose to use it knowing the risks, decide not to use it, or upgrade.
  • The documentation at doc.tiki.org is kept up to date for more recent versions, so expect to see there some documentation about features not available in your Tiki.

Other notes

  • Commits to LTS must have been developed and tested previously on higher branches (at least trunk/master) unless they do not apply there (for example, a fix to a feature that was removed later). See here for more info.
  • The community will handle merges from stable to dev, with help from a merging script during Semi-automatic merging period
  • On stable branches, try to avoid any changes to the database as this complicates things and increases possibilities for errors. If you must, please see: Database Schema Upgrade
  • If you must change the English version (but are not changing the meaning and so the translations are still valid, please use Mass spelling correction. If you can't use that, just add to Pending text corrections
  • If we are close to a release, and you have a change with a risk of regression, try to consult the release manager.
  • There are some things that are black and white and there are many shades of gray. In case of doubt, ask on the Dev Mailing List
  • https://trunkbaseddevelopment.com/

Legacy

There are no more planned releases of versions prior to 12, as well as versions 13, 14, 16 and 17. If you are running one and commit a fix , please merge manually your fix to the appropriate branch.

Examples

[+]

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