search

tc39 / proposal-built-in-modules

BSD 2-Clause "Simplified" License
892 stars 25 forks source link

Avoiding confusion about the purpose of this repository #43

Open martinheidegger opened 5 years ago

martinheidegger commented 5 years ago

Reading through #19 I feel like the name of this proposal might be confusing and/or off-putting.

There is seems to be nothing in this proposal that refers to the actual content of the standard-library (which things will definitely be included). But rather to improve the process of adding things to the existing "standard library: Array.util, etc." by introducing a namespace that offers access to it.

For that reason I am wondering if it might not be a good idea to rename this proposal to "proposal-builtin-namespace" that explains the motivation of creating namespace that can be consumed by users and defining a way which things get added to that namespace. (Without specifying what will go into it).

tabatkins commented 5 years ago

Agreed; while it's clear after you read thru a chunk of the README that this repo is about the mechanics of a standard library, not the contents, it's very easy to miss that, or just make a reasonable assumption from the repo name that talking about contents would be useful. (I made that mistake, after all!)

littledan commented 5 years ago

Bikeshedding, how about "proposal-builtin-module-infrastructure"?

martinheidegger commented 5 years ago

I like yours better 😉

tabatkins commented 5 years ago

proposal-builtin-module-infrastructure sounds great. Emphasizes the infrastructure, not the contents.

Could probably still also use a prominent first line in the README saying that this is not about collecting suggestions for stdlib contents, and honestly probably a line in the ISSUE_TEMPLATE restating that.

littledan commented 5 years ago

It's hard for me to imagine how the issue template could be more explicit. Do you have a specific suggestion?

tabatkins commented 5 years ago

Ah, I hadn't actually opened a new issue. ^_^

I'd... actually make it more explicit tho. Put your important disclaimer in the first line if you want people to read it!

Like, first line, all caps:

DO NOT OPEN AN ISSUE TO SUGGEST ADDING SOMETHING TO THE STDLIB

This repository is intended to discuss and develop the infrastructure of a new ES "standard library", not the contents. If you'd like to suggest something to add regardless, comment on .