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: document considerations for inclusion in core #40338

Closed
wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Oct 5, 2021

Document the things that are considered when making the determination as
to whether something should or shouldn't be in core. This does not (yet,
at least) attempt to address how to include modules in core. (Should
it be in the Node.js code base or vendored in from a separate
repository?) It is limited to whether something should be in core or
not.

Closes: nodejs/TSC#1041

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 5, 2021
@Trott
Copy link
Member Author

Trott commented Oct 5, 2021

@nodejs/tsc This is very much a first draft, but also possibly fit to land and be iterated upon to add more information. This is mostly a summary of what @mhdawson, @jasnell, and @ronag stated in #39779. There are other things that could be included in this document, but I don't think it pays to be exhaustive. I think we just want to include the most important elements and try to keep things to a length that people are likely to read and retain.

@Trott
Copy link
Member Author

Trott commented Oct 5, 2021

One thing I didn't include in the document, but perhaps I should: Once something is in core, it becomes all but impossible to remove it. "No" is "not now" but "yes" is forever.

@Trott Trott added the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label Oct 6, 2021
Trott added 2 commits October 19, 2021 21:32
Document the things that are considered when making the determination as
to whether something should or shouldn't be in core. This does not (yet,
at least) attempt to address *how* to include modules in core. (Should
it be in the Node.js code base or vendored in from a separate
repository?) It is limited to *whether* something should be in core or
not.

Closes: nodejs/TSC#1041
@Trott
Copy link
Member Author

Trott commented Oct 20, 2021

I think this is ready for some more reviews.

I'd like to stress that what I'm hoping for is to reach consensus that having this document as it stands is better than not having this document. If we try to get consensus that this is exactly right before landing, it will probably never land. We can always iterate on it after it lands.

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mhdawson
Copy link
Member

I'll probably submit a follow on PR to tweak a bit as it may still be a bit module/package specific but I think that its fine to do that in a follow on PR versus bikeshedding in this one :)

@Trott Trott requested review from mcollina, bmeck, mscdex and targos October 22, 2021 05:12
@Trott Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 22, 2021
@github-actions github-actions bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 22, 2021
@github-actions
Copy link
Contributor

Landed in 5c7af3f...89c0577

@github-actions github-actions bot closed this Oct 22, 2021
nodejs-github-bot pushed a commit that referenced this pull request Oct 22, 2021
Document the things that are considered when making the determination as
to whether something should or shouldn't be in core. This does not (yet,
at least) attempt to address *how* to include modules in core. (Should
it be in the Node.js code base or vendored in from a separate
repository?) It is limited to *whether* something should be in core or
not.

Closes: nodejs/TSC#1041

PR-URL: #40338
Fixes: nodejs/TSC#1041
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
targos pushed a commit that referenced this pull request Oct 23, 2021
Document the things that are considered when making the determination as
to whether something should or shouldn't be in core. This does not (yet,
at least) attempt to address *how* to include modules in core. (Should
it be in the Node.js code base or vendored in from a separate
repository?) It is limited to *whether* something should be in core or
not.

Closes: nodejs/TSC#1041

PR-URL: #40338
Fixes: nodejs/TSC#1041
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
@targos targos mentioned this pull request Nov 8, 2021
BethGriggs pushed a commit that referenced this pull request Nov 24, 2021
Document the things that are considered when making the determination as
to whether something should or shouldn't be in core. This does not (yet,
at least) attempt to address *how* to include modules in core. (Should
it be in the Node.js code base or vendored in from a separate
repository?) It is limited to *whether* something should be in core or
not.

Closes: nodejs/TSC#1041

PR-URL: #40338
Fixes: nodejs/TSC#1041
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
@BethGriggs BethGriggs mentioned this pull request Nov 26, 2021
1 task
@Trott Trott deleted the core branch September 25, 2022 17:10
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. tsc-agenda Issues and PRs to discuss during the meetings of the TSC.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

To be or not to be in core
9 participants