search

KittyCAD / modeling-app

The KittyCAD modeling app.
https://kittycad.io/modeling-app/download
MIT License
368 stars 30 forks source link

Changelog view or Breaking Change Message #3984

Open jgomez720 opened 5 days ago

jgomez720 commented 5 days ago

As we discussed in the post mortem, users had no visibility of the circle breaking change. This could be through

@jgomez720 to create an email template for these breaking changes in the future in hubspot (very needed after 1.0) https://github.com/KittyCAD/pet-store/issues/187

@jessfraz reassign to those you need

franknoirot commented 4 days ago

Here is the description I put in #3996 before I realized it was duplicate:

We recently shipped a purposeful breaking change in KCL with https://github.com/KittyCAD/modeling-app/pull/3860. However, because we didn't even have a updater toast at the time (we do now with https://github.com/KittyCAD/modeling-app/pull/3902), users never got a chance to see the changelog let alone get a sense of it being serious. They just saw their existing code with circle in it all break.

Now that we have an updater toast, we want to start making it possible to tune the loudness of the messaging in that notification so that users see breaking changes coming.

My initial simple proposal is that we add the full changelog back into this toast within a collapsible disclosure. If the changelog's contents have the term "breaking" in them, we set this disclosure to open by default, but otherwise we default it to closed.