Stream: Coq devs & plugin devs

Topic: breaking change section in changelog


view this post on Zulip Ali Caglayan (Aug 24 2022 at 11:29):

#16004 will introduce a breaking change. Would it be a good idea to have a dedicated section in the changlog to reflect this?

view this post on Zulip Théo Zimmermann (Aug 24 2022 at 11:48):

In principle, breaking changes are highlighted by having the Changed type. Changelog sections are used for topics.

view this post on Zulip Pierre-Marie Pédrot (Aug 24 2022 at 11:49):

that one is very breaking, we should probably have a way to signal this

view this post on Zulip Théo Zimmermann (Aug 24 2022 at 11:49):

The changelog entries are ordered by types within a section, Changed appear first in entry.

view this post on Zulip Théo Zimmermann (Aug 24 2022 at 11:49):

Pierre-Marie Pédrot said:

that one is very breaking, we should probably have a way to signal this

The way we signal very breaking changes is in the release summary usually.

view this post on Zulip Théo Zimmermann (Aug 24 2022 at 11:50):

This one https://coq.github.io/doc/master/refman/changes.html#version-8-11 even had some bold text in the release summary.

view this post on Zulip Michael Soegtrop (Aug 24 2022 at 17:09):

Maybe instead of "changed" we could have "high impact change" and "low impact change".

view this post on Zulip Théo Zimmermann (Aug 24 2022 at 17:29):

Sure, but the issue with these distinctions is that you always have trouble figuring out on which side of the frontier some changes go...

view this post on Zulip Michael Soegtrop (Aug 24 2022 at 17:42):

I think this can be derived from the amount of effort to fix all projects in CI (size of the diff e.g.).


Last updated: Feb 01 2023 at 16:03 UTC