#Release Notes
1 messages · Page 1 of 1 (latest)
Yeah I think we should have one — at the very least to give a summary of the breaking changes
No idea on who/where/what though
I propose that we add a changelog page under the Go SDK category.
The format could follow this: https://gist.github.com/juampynr/4c18214a8eb554084e21d6e288a18a2c or https://keepachangelog.com/en/1.0.0/.
If agreeable, I can prepare a stub file and you can add log entries to it, or you can lmk the changes and I can draft it (whatever you prefer)
Works for me but I defer to @loud quiver .
I believe at some point we generated a changelog straight from git log, using commit message prefixes to help reduce noise?
Also, for major releases with big features, would it make sense to add an "executive summary", basically a hand-written note highlighting the most important parts and why the reader should care?
Kind of a middle ground between the "laundry list" format of the changelog, and a full blown marketing blog post?
Importantly it would be written directly by the engineers (unlike launch blog posts which need more cooks in the kitchen)
Agree with the exec summary idea and that it should be written by our dev team