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

doc: explanation about flagged feature etiquette needed #22021

Open
devsnek opened this issue Jul 29, 2018 · 5 comments
Open

doc: explanation about flagged feature etiquette needed #22021

devsnek opened this issue Jul 29, 2018 · 5 comments
Labels
doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed.

Comments

@devsnek
Copy link
Member

devsnek commented Jul 29, 2018

There is a lot of misunderstanding in the ecosystem about how harmony* and experimental flags should be used, most alarmingly in the case of libraries that ship support for features that are flagged.

We need to document:

  • Why flags are how we (and V8*) ship experimental features
  • Why you should only use flagged features at an application level
  • Why you shouldn't use flagged features in production environments
  • Why you shouldn't publish versions of your libraries with support for flagged features
  • Given the restrictions above, ways that you can help us test flagged features

This seems like a lot for one person so I thought I would open an issue about it and get some collaboration going.

*We probably shouldn't document V8's flagging, but it might be necessary to at least mention harmony flags.

@devsnek devsnek added help wanted Issues that need assistance from volunteers or PRs that need help to proceed. doc Issues and PRs related to the documentations. labels Jul 29, 2018
@TimothyGu
Copy link
Member

See also https://nodejs.org/en/docs/es6/.

@AdityaSrivast
Copy link
Contributor

AdityaSrivast commented Aug 18, 2018

@devsnek I want to work on this issue. Can you tell me what is to be done, please?

@devsnek
Copy link
Member Author

devsnek commented Aug 19, 2018

@AdityaSrivast pretty much just compositing the points in my comment and the link Timothy sent. I think introducing a replacement of that es6 page might be the best option here.

@AdityaSrivast
Copy link
Contributor

@devsnek There's a problem. I don't know the answer to these questions 😅 Is there still any way I can fix it, please?

@Trott
Copy link
Member

Trott commented Nov 16, 2018

Maybe we can get this moving a bit by scaling back what we hope to document, at least on the first pass. Here's the list initially proposed by @devsnek but with a lot of the "why" stuff changed to simply documenting that's-the-way-it-is.

  • Only use flagged features at an application level.
    • What does "application level" mean here?
  • Do not use flagged features in production environments.
  • Do not publish versions of your libraries with support for flagged features.
    • Should we simplify to "do not publish libraries that rely on flagged features (perhaps except when such modules are explicitly experimental/unstable/not-for-production themselves?)"
  • Given the restrictions above, ways that you can help us test flagged features.
    • This is the task on this checklist that needs the most effort/attention.

@tniessen tniessen changed the title doc: explaination about flagged feature etiquette needed doc: explanation about flagged feature etiquette needed Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed.
Projects
None yet
Development

No branches or pull requests

4 participants