Skip to content

Require design rationals for proposals #481

@Robbepop

Description

@Robbepop

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:

This larger road map admittedly is a bit difficult to extract from individual proposal repos. Respective discussions tend to be buried in GH issues and meeting notes, and it is of course changing constantly. We could probably do a better job at documenting it.

This is exactly why I think that design rationals could be a nice requirement for Wasm proposals. When I was reading the base Wasm spec I was having sooo many questions behind certain designs until I found the design rational docs. Really one of my most loved Wasm docs so far.

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.

  • New people that try to get into a discussion of a proposal will have a simpler time getting into the topic.
  • The general Wasm spec can simply use the provided rationals in their own required rationals docs.
  • Proposal authors have a proper way to communicate the results of the accumulation of their thoughts about their proposal in a brief way which strengthens their arguments for their current design or at least makes them more understandable for others.

Metadata

Metadata

Assignees

No one assigned

    Labels

    processIssues concerning the documents in the process directory.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions