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

Versioning the webxdc spec and adding a changelog #81

Open
hpk42 opened this issue Jul 11, 2024 · 2 comments
Open

Versioning the webxdc spec and adding a changelog #81

hpk42 opened this issue Jul 11, 2024 · 2 comments

Comments

@hpk42
Copy link
Contributor

hpk42 commented Jul 11, 2024

Brought up from @singpolyma and also been under consideration elsewhere.

It would be useful to start versioning the spec and having a changelog.

I don't have a ready suggestion but do intend to care for this during july if nobody beats me to it.

Relatedly, i intend to chat with @ansuz about evolving the webxdc spec :)

@Simon-Laux
Copy link
Contributor

Simon-Laux commented Jul 11, 2024

The closest thing we currently have for version is the changelog of the typescript types package: https://github.com/webxdc/webxdc-types/blob/main/CHANGELOG.md

If you want some historical stuff instead of just making a version one and only recording future changes. I think it's fine to just start recording future changes as the webxdc community is still small, maybe start before realtime channels, idk.

While I agree with making a changelog, I believe we should recommend to test if api's are available instead of some version number and try not to break existing apis.
Like I'd like to avoid a getWebxdcVersion api for testing what apis are available if we can.

@hpk42
Copy link
Contributor Author

hpk42 commented Jul 12, 2024

(nb. i fixed the link in your reply)
The question of how to detect supported features from webxdc apps i consider as a separate issue.

Versioning of webxdc spec and changelog here is meant to support implementors so they get a way to talk and reference it in other docs like "Support webxdc.sendupdate() function as defined in webxdc-spec-1.3".
And the changelog should be human-readable for implementors and webxdc app developers.

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

2 participants