mirror of
https://github.com/TiddlyWiki/TiddlyWiki5.git
synced 2026-04-25 08:24:35 +00:00
f1ce35036e
* Introduce impact notes attached to change notes No styles yet * Add more tickets for demo and testing purposes * Slightly better description for v5.4.0 * Formatting. More to do. * Embarrassing typo * Update field names * Styling refinements * Disable the #8702 changenote as it is not yet merged * Add incompleteness warning
60 lines
1.7 KiB
Plaintext
60 lines
1.7 KiB
Plaintext
title: Release Notes and Changes
|
|
|
|
See [[Release Notes and Changes Internals]] for a detailed breakdown of the tiddlers that make up a release note.
|
|
|
|
! Release Notes
|
|
|
|
Release notes describe the changes in a release, and the impact of those changes. They comprise the following information:
|
|
|
|
* the version number (eg `5.4.0`)
|
|
* the release date if the release has been published
|
|
* a brief description of the release
|
|
|
|
! Change Notes
|
|
|
|
Change notes describe a discrete change within a release. Change note comprise the following information:
|
|
|
|
* the associated release
|
|
* the change-type from the list below
|
|
* the change-category from the list below
|
|
* a description of the change
|
|
* a list of the ~GitHub links associated with this change
|
|
* a list of the ~GitHub handles of the developers responsible for the PR/commits
|
|
|
|
Valid change note types are as follows:
|
|
|
|
* ''bugfix''
|
|
* ''feature''
|
|
* ''enhancement''
|
|
* ''deprecation''
|
|
* ''security''
|
|
* ''performance''
|
|
|
|
Valid change categories are as follows:
|
|
|
|
* ''internal''
|
|
* ''translation''
|
|
* ''plugin''
|
|
* ''widget''
|
|
* ''filters''
|
|
* ''usability''
|
|
* ''palette''
|
|
* ''hackability''
|
|
* ''nodejs''
|
|
* ''performance''
|
|
* ''developer''
|
|
|
|
! Impact Notes
|
|
|
|
Impact notes describe the impact of a particular change. There can be multiple impact notes for a given change. They comprise the following information:
|
|
|
|
* the associated change note
|
|
* a description of the impact
|
|
* the impact type from the list below
|
|
|
|
Valid impact types are as follows:
|
|
|
|
* ''deprecation'' - there are features or functionality that should no longer be used in new code
|
|
* ''compatibility-break'' - changes are included that break backwards compatibility
|
|
* ''pluginisation'' - functionality has been moved from the core to a plugin
|