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

Avoiding confusion about the purpose of this repository #43

Open
martinheidegger opened this issue Dec 20, 2018 · 6 comments
Open

Avoiding confusion about the purpose of this repository #43

martinheidegger opened this issue Dec 20, 2018 · 6 comments

Comments

@martinheidegger
Copy link

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
Copy link

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
Copy link
Member

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

@martinheidegger
Copy link
Author

I like yours better 😉

@tabatkins
Copy link

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
Copy link
Member

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

@tabatkins
Copy link

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 .

@littledan littledan changed the title builtin-namespace Avoiding confusion about the purpose of this repository Dec 22, 2018
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

3 participants