diff options
Diffstat (limited to 'doc/development/changelog.md')
| -rw-r--r-- | doc/development/changelog.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/development/changelog.md b/doc/development/changelog.md index b8e879c1826..894ae5a1893 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Changelog entries @@ -47,7 +47,7 @@ the `author` field. GitLab team members **should not**. - Any user-facing change **must** have a changelog entry. This includes both visual changes (regardless of how minor), and changes to the rendered DOM which impact how a screen reader may announce the content. - Any client-facing change to our REST and GraphQL APIs **must** have a changelog entry. - Performance improvements **should** have a changelog entry. -- Changes that need to be documented in the Product Analytics [Event Dictionary](https://about.gitlab.com/handbook/product/product-analytics-guide#event-dictionary) +- Changes that need to be documented in the Product Analytics [Event Dictionary](https://about.gitlab.com/handbook/product/product-analytics-guide/#event-dictionary) also require a changelog entry. - _Any_ contribution from a community member, no matter how small, **may** have a changelog entry regardless of these guidelines if the contributor wants one. @@ -55,7 +55,7 @@ the `author` field. GitLab team members **should not**. - Any docs-only changes **should not** have a changelog entry. - Any change behind a disabled feature flag **should not** have a changelog entry. - Any change behind an enabled feature flag **should** have a changelog entry. -- Any change that adds new usage data metrics and changes that needs to be documented in Product Analytics [Event Dictionary](https://about.gitlab.com/handbook/product/product-analytics-guide#event-dictionary) **should** have a changelog entry. +- Any change that adds new usage data metrics and changes that needs to be documented in Product Analytics [Event Dictionary](https://about.gitlab.com/handbook/product/product-analytics-guide/#event-dictionary) **should** have a changelog entry. - A change that adds snowplow events **should** have a changelog entry - - 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. @@ -118,7 +118,7 @@ Its simplest usage is to provide the value for `title`: bin/changelog 'Hey DZ, I added a feature to GitLab!' ``` -If you want to generate a changelog entry for GitLab EE, you will need to pass +If you want to generate a changelog entry for GitLab EE, you must pass the `--ee` option: ```plaintext @@ -144,10 +144,10 @@ At this point the script would ask you to select the category of the change (map ``` The entry filename is based on the name of the current Git branch. If you run -the command above on a branch called `feature/hey-dz`, it will generate a +the command above on a branch called `feature/hey-dz`, it generates a `changelogs/unreleased/feature-hey-dz.yml` file. -The command will output the path of the generated file and its contents: +The command outputs the path of the generated file and its contents: ```plaintext create changelogs/unreleased/my-feature.yml @@ -175,7 +175,7 @@ type: You can pass the **`--amend`** argument to automatically stage the generated file and amend it to the previous commit. -If you use **`--amend`** and don't provide a title, it will automatically use +If you use **`--amend`** and don't provide a title, it uses the "subject" of the previous commit, which is the first line of the commit message: |