Change Log Guidelines: Difference between revisions

From EiffelStudio: an EiffelSoftware project
Jump to navigation Jump to search
Manus (talk | contribs)
m Added category
m Added sections to be used for beta releases.
 
Line 3: Line 3:
* Only add bug fixes for versions actually released
* Only add bug fixes for versions actually released
* Mark major new features/bug fixes in red using the <nowiki>{{Red|...}}</nowiki> template.
* Mark major new features/bug fixes in red using the <nowiki>{{Red|...}}</nowiki> template.
* Each entry should be prefixed by a category:
* Each entry should be prefixed by a category, with subcategory in parentheses:
**compiler
** compiler
**studio
** studio
**base
** library(base), library(vision2), etc.
**vision2
** build
**build
** debugger
**debugger
** run-time
**c_compilation
* When entering a bug fix we should always refer to the corresponding bug# or test#
* When entering a bug fix we should always refer to the corresponding bug# or test#
* Use the following sections for beta releases:
** ===New features===
** ===Improvements===
** ===Bug fixes===
** ===Feature removed===
** ===User changes===
** ===Developer changes===

Latest revision as of 14:40, 22 May 2019

A few guidelines for adding entries in the Change Log:

  • Only add bug fixes for versions actually released
  • Mark major new features/bug fixes in red using the {{Red|...}} template.
  • Each entry should be prefixed by a category, with subcategory in parentheses:
    • compiler
    • studio
    • library(base), library(vision2), etc.
    • build
    • debugger
    • run-time
  • When entering a bug fix we should always refer to the corresponding bug# or test#
  • Use the following sections for beta releases:
    • ===New features===
    • ===Improvements===
    • ===Bug fixes===
    • ===Feature removed===
    • ===User changes===
    • ===Developer changes===