diff --git a/content/community/2.contribution/4.pull-requests.md b/content/community/2.contribution/4.pull-requests.md index c43af3432..bf291f17a 100644 --- a/content/community/2.contribution/4.pull-requests.md +++ b/content/community/2.contribution/4.pull-requests.md @@ -36,3 +36,37 @@ The following are the types of version bumps that can be specified in a changese - Major (x.0.0) - A change has been made that is incompatible with previous versions. - Minor (0.x.0) - A feature has been added that is backwards compatible with previous versions. - Patch (0.0.x) - A bug has been fixed that is backwards compatible with previous versions. + +### Notices + +Use a notice for changes that deserve extra visibility in the release notes, such as deprecations, required migrations, or behavior changes that users upgrading and/or extension authors should be aware of. + +Add a `::: notice` block at the end of the changeset body: + +```markdown +--- +"@directus/app": minor +--- + +Deprecated the `VResizeable` component + +::: notice + +- Deprecation for extensions: The globally registered `VResizeable` component has been deprecated. Extension authors should migrate to `@directus/vue-split-panel` or provide their own implementation. + +::: +``` + +The notice is extracted and displayed in the **Potential Breaking Changes** section at the top of the release notes. The rest of the changeset remains in its normal category. + +Notices always appear under **Potential Breaking Changes**, regardless of whether the changeset is a major, minor, or patch release. Adding a notice does not affect the version bump. Choose the bump type based on the impact of the change, and add a notice whenever the change warrants additional attention. + +**Notice detection is strict.** If the syntax does not match exactly, the notice will not be extracted. + +To ensure your notice is recognized: + +- Start the block with exactly `::: notice`: all lowercase, with a single space between `:::` and `notice`. +- End the block with `:::` on its own line. +- Do not indent the opening or closing markers, or include trailing whitespace. +- Include some content between the markers. An empty block is not detected. +- Include exactly one notice block per changeset. Multiple notce blocks will result in a malformed output