Skip to content

Update changelog content type guidelines #5250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lcawl wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update changelog content type guidelines #5250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions contribute-docs/content-types/_snippets/changelog-fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ issues:
# They are externalized in the release docs so users can follow the links and
# understand the context.

pr:
prs:

# An optional string that contains the pull request identifier.
# It is externalized in the release docs so users can follow the link and find more details.
# An optional array of pull request identifiers (URLs or numbers).
# Each value is externalized in the release docs so users can follow the links and find more details.

subtype:

Expand Down
2 changes: 1 addition & 1 deletion contribute-docs/content-types/changelogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Consider including the following elements when they add value:

- **Description**: Additional information about the change (maximum 600 characters). For guidance, go to [Write effective descriptions](#changelog-descriptions).
- **Areas**: The components, features, or product areas affected by the change (for example, "{{esql}}" or "{{ml-app}}").
- **PR** and **issues**: The numbers or URLs for the related pull request and issues.
- **Issues** and **prs**: The numbers or URLs for the related issues and pull requests.
- **Feature-id**: If you want to be able to track changelogs associated with a specific feature flag or filter them out of the documentation, add a unique identifier.

The following elements apply to specific types of changes:
Expand Down
Loading