diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b56e137966a..dade6e40d44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,13 +73,14 @@ Merges to this repository must include one or more changelog entries which descr Entries are placed in the top-level `.changes/` directory. An entry is a file containing a JSON object with the following fields: -| Field name | Type | Required | Enum | Description | -|---------------|------------|----------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | `string` | yes | | A unique identifier for this entry. We recommend you generate a UUID for this field. | -| `type` | `string` | yes | `bugfix`, `feature`, `documentation`, `misc` | The type of change being made. | -| `description` | `string` | yes | | A description of the change being made. | -| `issues` | `string[]` | no | | A list of references to any related issues in the relevant repositories. A reference can be specified in several ways: | -| `module` | `string` | no | | The area of the code affected by your changes. If unsure, leave this value unset. | +| Field name | Type | Required | Enum | Description | +|----------------------------|------------|----------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | `string` | yes | | A unique identifier for this entry. We recommend you generate a UUID for this field. | +| `type` | `string` | yes | `bugfix`, `feature`, `documentation`, `misc` | The type of change being made. | +| `description` | `string` | yes | | A description of the change being made. | +| `issues` | `string[]` | no | | A list of references to any related issues in the relevant repositories. A reference can be specified in several ways: | +| `module` | `string` | no | | The area of the code affected by your changes. If unsure, leave this value unset. | +| `requiresMinorVersionBump` | `boolean` | no | | Indicates the change will require a new minor version. This is usually the case after a breaking change. Defaults to false if flag is not included. | The filename of an entry is arbitrary. We recommend `.json`, where `` corresponds to the `id` field of the entry itself.