-
Notifications
You must be signed in to change notification settings - Fork 154
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
Require design rationals for proposals #481
Comments
Thanks for writing this up! I'll add this to the agenda for discussion in the next meeting. If you are a CG member, feel free to join the meeting to begin the discussion. Otherwise, I'm happy to bring do it. |
As far as I am aware of I am not a member and I'd be happy if you can bring it up there. :) |
You can join the CG here, if you like: https://www.w3.org/community/webassembly. We ask that people join the group if they'd like to attend the meetings. Otherwise, you can read the meeting notes posted afterward. |
We discussed this in the Jan 21 CG meeting. In general, folks were in favor of doing this. We discussed a bit and decided we'd try to determine how to make progress offline. @tlively @fgmccabe @RossTate you all seemed to have opinions about how best to do this. |
I'm hoping to finish drafting a design-rationale document for our proposal this week. That might be a useful example of a rationale document that was developed early in the proposal process, and I'll be happy to get criticism as to how it can be improved. If y'all think such a concrete and current example might help structure the discussion, I'm happy to link to it here once it's done. |
It would definitely be useful to get input from various current proposals about what kinds of questions are asked most frequently and what the most successful organization of information has been. I would be in favor of collaborating on a proposal template or set of templates. I thought @binji's idea of placing these templates in the proposals repo was a good one. |
A preliminary draft of our design rationale can now be found in the ongoing pull request: https://github.com/soil-initiative/gc/pull/1 |
We had a brief discussion about adding a requirement for rationals for WebAssembly proposals.
You can read more about the existing discussion here:
WebAssembly/reference-types#71
The motivation for this is mainly the following:
In general we already have a pretty impressive rationals design document for the general WebAssembly specification. We simply lack those for all the WebAssembly proposals in the pipeline. Since we already have the rationals design document for the generial Wasm specification we are already in need of enumerating those rationals once a proposal has been merged into the official standard. Requiring proposal authors to do this upfront will have the additional benefit of tracking the current state of design rationals of all proposals and upon merging they could simply be merged into the official Wasm spec rationals design document.
This puts a bit of work into the hands of Wasm proposal authors, lifts of work from the general Wasm spec maintainers (also they might not even know what rationals are behind the design decisions that have been made) and further improves acceleration of development through making the discussions available for a wider audience. (Nobody has time to read every single detail in a proposal to make themselves aware of all the rationals but everybody interested enough should have enough time to read through a brief design rationals document).
All in all I'd say having rationals requirements is a win for all parties.
The text was updated successfully, but these errors were encountered: