diff options
Diffstat (limited to 'doc/development/changelog.md')
| -rw-r--r-- | doc/development/changelog.md | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 5a8e05f888c..00a0573a8ba 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -14,12 +14,12 @@ following format: --- title: "Change[log]s" merge_request: 1972 -author: Black Sabbath +author: Black Sabbath @bsabbath type: added ``` The `merge_request` value is a reference to a merge request that adds this -entry, and the `author` key is used to give attribution to community +entry, and the `author` key (format: `<full name> <GitLab username>`) is used to give attribution to community contributors. **Both are optional**. The `type` field maps the category of the change, valid options are: added, fixed, changed, deprecated, removed, security, performance, other. **Type field is mandatory**. @@ -42,10 +42,9 @@ the `author` field. GitLab team members **should not**. Example: "Fixed a typo on the search results page." - Any docs-only changes **should not** have a changelog entry. - Any change behind a feature flag **should not** have a changelog entry - unless - the feature flag has been defaulted to true. The entry should be added - [in the merge request removing the feature flags](feature_flags/development.md). - If the change includes a database migration (regular, post, or data migration), - there should be a changelog entry for the migration change. + the feature flag has been defaulted to true. +- A change that [removes a feature flag](feature_flags/development.md) **should** have a changelog entry - + only if the feature flag did not default to true already. - A fix for a regression introduced and then fixed in the same release (i.e., fixing a bug introduced during a monthly release candidate) **should not** have a changelog entry. |