Change Log Guidelines

Revision as of 06:40, 22 May 2019 by Alexander Kogtenkov (Talk | contribs) (Added sections to be used for beta releases.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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===