Commit 2ef57458 authored by charlie ablett's avatar charlie ablett Committed by Rémy Coutable

Clarify changelog docs for feature flags

parent 3c77db60
...@@ -42,10 +42,9 @@ the `author` field. GitLab team members **should not**. ...@@ -42,10 +42,9 @@ the `author` field. GitLab team members **should not**.
Example: "Fixed a typo on the search results page." Example: "Fixed a typo on the search results page."
- Any docs-only changes **should not** have a changelog entry. - Any docs-only changes **should not** have a changelog entry.
- Any change behind a feature flag **should not** have a changelog entry - unless - 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 the feature flag has been defaulted to true.
[in the merge request removing the feature flags](feature_flags/development.md). - A change that [removes a feature flag](feature_flags/development.md) **should** have a changelog entry -
If the change includes a database migration (regular, post, or data migration), only if the feature flag did not default to true already.
there should be a changelog entry for the migration change.
- A fix for a regression introduced and then fixed in the same release (i.e., - 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** fixing a bug introduced during a monthly release candidate) **should not**
have a changelog entry. have a changelog entry.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment