Skip to content
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.

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

Provide release notes / diff when spec is updated #1283

Closed
jasonwyatt opened this issue Jan 28, 2021 · 5 comments
Closed

Provide release notes / diff when spec is updated #1283

jasonwyatt opened this issue Jan 28, 2021 · 5 comments

Comments

@jasonwyatt
Copy link

I've been working on an interpreter as a side-project for a while now and I just noticed that the spec's version was recently bumped from 1.0 to 1.1, but there isn't an easy-to-find list of the changes/additions made in the release.

It would be great to provide release notes whenever the spec is updated, especially as the spec evolves quickly.

@philipahlberg
Copy link

philipahlberg commented Jan 30, 2021

To add to this, it would also be nice to have the spec for older versions published alongside the newest version.

@tlively
Copy link
Member

tlively commented Jan 31, 2021

I agree this is an important issue. See also WebAssembly/design#1395 for a similar request. @rossberg, would it make sense to have a change log appendix in the spec? Would there be a better mechanism to make changes more discoverable?

@rossberg
Copy link
Member

rossberg commented Feb 3, 2021

An appendix summarising new features and other changes makes total sense to me. The only existing "mechanism" would be the list of finished proposals, which should reflect what was added. The design docs of merged proposals are also archived in the spec repo.

@helins
Copy link

helins commented Mar 13, 2021

I confirm that not having even a basic changelog is cumbersome. I am writing a WASM decompiler/compiler and by pure chance have noticed new additions yesterday (ref instructions and so one). I am currently re-reading all specs to guess what changed.

This is even more important if the purpose is having "living specs" that everyone is supposed to keep up with. It should be easy to find out "how" to keep up.

@rossberg
Copy link
Member

rossberg commented Apr 8, 2021

Fixed by #1306.

@rossberg rossberg closed this as completed Apr 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants