1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-28 00:03:16 +00:00

Docs updates

This commit is contained in:
Jermolene 2013-12-02 09:59:44 +00:00
parent b149ab47f4
commit 41fc06ab4d
3 changed files with 50 additions and 1 deletions

View File

@ -11,8 +11,15 @@ type: text/vnd.tiddlywiki
!! Improvements
* If `$:/theme` isn't defined or refers to a missing tiddler, then fallback through ''Snow White'' to ''Vanilla''. This means that `empty.html` now defaults to ''Snow White''
* Changes to the importing process to enable a smoother [[TiddlyWiki5 Upgrade Process]]
** Ignores attempts to import plugins that are older than currently installed plugins
** System tiddlers are now imported as usual
!! Bug fixes
* Fixed bug that was preventing `$:/tags/PageControls` tiddlers from being reordered
!! Internal changes
* Changed the [[TiddlyWiki5 Versioning]] policy
** New alpha releases will be `5.0.x-alpha`, beta releases will be `5.1.x-beta` and the final release will be `5.2.x`

View File

@ -0,0 +1,42 @@
created: 20131202081424080
creator: JeremyRuston
modified: 20131202082237877
modifier: JeremyRuston
tags: dev
title: TiddlyWiki5 Versioning
type: text/vnd.tiddlywiki
Each release of TiddlyWiki5 is identified by a version number that complies with the [[Semantic Versioning 2.0.0|http://semver.org/]] standard.
! TiddlyWiki Core Version
According to the standard:
```
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
```
!! Alpha and Beta versions
While in alpha TiddlyWiki5 uses the pre-release label "alpha", for example:
```
5.0.1-alpha
```
Each new alpha or beta release will bump the `PATCH` version number. This breaks the strict semantics of versioning because `PATCH` increments are supposed to be reserved for compatible changes.
!! Interim versions
During development when a new release is being prepared, the pre-release label is set to `prerelease`.
! Plugin Versions
Version numbers
TiddlyWiki5 uses the version information attached to plugins for determining which of two plugins is more recent during an upgrade or import. The pre-release label is ignored when performing these comparisons.

File diff suppressed because one or more lines are too long