Hi All,

As discussed in the community sync today, Polaris evolves quickly and
breaking changes are a reality we have to live with :)

However, I'd like to propose improving user and developer experience by
keeping a change log with a section for breaking changes.

We follow this practice in Nessie [1] with the help of the
"jetbrains-changelog" build plugin to automate adding versioned sections [2]

* PRs that have strong user-visible effects also update the appropriate
section of the change log.
* At release time, the "in progress" entries are moved to a version
sub-section automatically.
* I'd also propose additionally mentioning PRs with "breaking changes" on
the dev ML list before merging.

WDYT about introducing this workflow in Polaris?

Thanks,
Dmitri.

[1] https://github.com/projectnessie/nessie/blob/main/CHANGELOG.md
[2] https://github.com/projectnessie/nessie/pull/7243

Reply via email to