Skip to content

Add Breaking changes to release note order #833

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

Open
ebyhr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Breaking changes to release note order #833

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
7 changes: 4 additions & 3 deletions development/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,11 @@ For example, Trino release are ordered following the

In each section different release notes entries are sorted:

1. **New features**: Start with `Add` or `Add support for` or similar wording
2. **Performance improvements**: Start with `Improve` or `Improve performance`
1. **Breaking changes**: Start with `{{breaking}}`
Copy link
Copy Markdown
Member Author

@ebyhr ebyhr Apr 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should mention breaking changes either at the beginning or at the end.

@mosabua @martint What do you think?

Copy link
Copy Markdown
Member

@mosabua mosabua Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good to me. We might want to detail that a breaking change is something user facing only (including configuration stuff). Or even just link to https://trino.io/docs/current/release.html#breaking-changes

2. **New features**: Start with `Add` or `Add support for` or similar wording
3. **Performance improvements**: Start with `Improve` or `Improve performance`
or similar wording
3. **Bug fixes**: Start with `Fix` or `Prevent` or similar wording
4. **Bug fixes**: Start with `Fix` or `Prevent` or similar wording

Use [imperative present tense, as used in a command or
request](https://en.wikipedia.org/wiki/Imperative_mood) to describe the change.
Expand Down