Skip to content

Adopt a charter #105

Description

@chrisdickinson

@iojs/streams

There's work going on over here to formalize the relationship between the TC and the WGs. One item that would be particularly useful is the concept of a charter.

Roughly speaking, this would delimit the scope of responsibilities of this WG, while also serving as a sort of "true north" for our decision-making. We've already touched on this issue a bit (see #99). While we each have our own ideas of how streams can and should evolve to better serve the needs of users, without a clearly stated goal these changes can be arbitrary, or may actually impede future improvements if we're not careful. Conversely, if we have a common goal, we can direct our efforts together to reach it.

We're working a bit backwards here owing to the fact that we're one of the first WGs, so whatever we decide here will ultimately have to be presented to and approved by the io.js TC.

Without further ado, here's a stab at a charter. Feel free to suggest edits or start from scratch:


The Streams WG is dedicated to the support and improvement of the Streams API as used in io.js and the npm ecosystem. We seek to create a composable API that solves the problem of representing multiple occurrences of an event over time in a humane, low-overhead fashion. Improvements to the API will be driven by the needs of the ecosystem; interoperability and backwards compatibility with other solutions and prior versions are paramount in importance. Our responsibilities include:

  • Addressing stream issues on the io.js issue tracker.
  • Authoring and editing stream documentation within the io.js project.
  • Reviewing changes to stream subclasses within the io.js project.
  • Redirecting changes to streams from the io.js project to this project.
  • Assisting in the implementation of stream providers within io.js.
  • Recommending versions of readable-stream to be included in io.js.
  • Messaging about the future of streams to give the community advance notice of changes.

Activity

  1. sonewman commented on Jan 28, 2015

    @sonewman
    Contributor

    I think this a good idea and everything in the list seems reasonable.
    It also does feel very agile like!
    +1

  2. mikeal commented on Jan 30, 2015

    @mikeal

    Reviewing changes to stream subclasses within the io.js project.

    Isn't the plan to vendor readable-stream?

  3. domenic commented on Jan 30, 2015

    @domenic

    Sure, but not vendor e.g. CryptoStream, so we should still review that code even though it's not in this repo.

  4. chrisdickinson commented on Feb 20, 2015

    @chrisdickinson
    ContributorAuthor

    This was merged into io.js!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions