Difference between revisions of "Change Log Guidelines"
(Initial guidelines for change log) |
m (Added sections to be used for beta releases.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Category:Releases]] | ||
A few guidelines for adding entries in the Change Log: | A few guidelines for adding entries in the Change Log: | ||
* 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. |
| − | + | ** build | |
| − | **build | + | ** debugger |
| − | **debugger | + | ** run-time |
| − | ** | + | |
* 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 05: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===
