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: add technical values document #35145

Closed
wants to merge 8 commits into from
Closed

Conversation

mhdawson
Copy link
Member

As part of the next-10 we found
we needed to capture the project's technical values/priorities as
a starting point before discussing key technologies/areas for the
next 10 years of Node.js

This is a first cut that the team put together. The discussion
took place in a few meetings as well as this
PR. We believe the doc
should live in the core node repository as it is intended to
reflect the agreement of the collaborator base.

I think this is a good starting point but we also
acknowledge that only a small subset of the Node.js collaborators
have participated/commented so far. This PR should be a good
way to get additional review/input from the larger set
of Node.js collaborators.

Signed-off-by: Michael Dawson mdawson@devrus.com

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 10, 2020
@mhdawson mhdawson added the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label Sep 10, 2020
Copy link

@gittysachin gittysachin left a comment

Choose a reason for hiding this comment

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

Would be great to have the technical values/prioritization document before the key discussion about new technology implementation or any area of future Node.js

@mhdawson
Copy link
Member Author

@gittysachin that was what we ended up thinking based on the discussion in the next-10 team and what led to the creation of this initial version of that.

@mmarchini
Copy link
Contributor

this feels like one of those times where @nodejs/collaborators is appropriate

@Trott
Copy link
Member

Trott commented Sep 11, 2020

I think we should be exceptionally stingy with the root-level all-caps file and would prefer this go in doc/guides/technical-values.md or similar.

@mhdawson
Copy link
Member Author

@Trott I think I'm ok with it being in guides since it does have a visible path through the README.md

@GeoffreyBooth
Copy link
Member

Two thoughts:

  1. What is “API currency”?

  2. I see and appreciate the reference to Web APIs. I’m not sure if we need to say anything more, but I think perhaps the biggest driver of Node’s popularity has been the fact that it’s a JavaScript runtime and there’s tremendous value in having code that can run in both browsers and on the server, or at least that apps can share the same language between client and server. I think maintaining compatibility with the browser environments as much as possible is an important technical value to maintain.

@mhdawson mhdawson added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 17, 2020
@mhdawson
Copy link
Member Author

mhdawson commented Sep 17, 2020

@GeoffreyBooth updated to use clearer wording for "currency",

In terms of:

I see and appreciate the reference to Web APIs. I’m not sure if we need to say anything more, but I think perhaps the biggest driver of Node’s popularity has been the fact that it’s a JavaScript runtime and there’s tremendous value in having code that can run in both browsers and on the server, or at least that apps can share the same language between client and server. I think maintaining compatibility with the browser environments as much as possible is an important technical value to maintain.

I think we discussed that in the next-10 meetings and stopped short of mentioning that specifically. Since you mentioned as "thoughts" as opposed to an objection I'm going to land the current text and maybe you can PR in a suggested addition that covers that and we can use the PR to discuss.

@mhdawson
Copy link
Member Author

As doc only I guess I did not need to request the CI, linters seem to have complete so I think I'm good to land.

@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 17, 2020
@nodejs-github-bot
Copy link
Collaborator

mhdawson added a commit that referenced this pull request Sep 17, 2020
As part of the [next-10](https://github.com/nodejs/next-10) we found
we needed to capture the project's technical values/priorities as
a starting point before discussing key technologies/areas for the
next 10 years of Node.js

This is a first cut that the team put together. The discussion
took place in a few meetings as well as this
[PR](nodejs/next-10#11). We believe the doc
should live in the core node repository as it is intended to
reflect the agreement of the collaborator base.

I think this is a good starting point but we also
acknowledge that only a small subset of the Node.js collaborators
have participated/commented so far. This PR should be a good
way to get additional review/input from the larger set
of Node.js collaborators.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #35145
Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
@mhdawson
Copy link
Member Author

Landed in fe293e9

Going to leave open until we hear back with @GeoffreyBooth that he's ok with my suggested approach to his comment on browser compatibility in case I need to take some other action.

@GeoffreyBooth
Copy link
Member

Landed in fe293e9

Going to leave open until we hear back with @GeoffreyBooth that he’s ok with my suggested approach to his comment on browser compatibility in case I need to take some other action.

Yes, it’s not an objection, just a suggestion. Was there a reason it was left out when you discussed it in those meetings?

@mhdawson
Copy link
Member Author

@GeoffreyBooth If I remember correctly it came down being related to your comment I’m not sure if we need to say anything more and that there is not necessarily agreement across the project that compatibility with the browser environments is always the right path so we just left it at what was there.

ruyadorno pushed a commit that referenced this pull request Sep 21, 2020
As part of the [next-10](https://github.com/nodejs/next-10) we found
we needed to capture the project's technical values/priorities as
a starting point before discussing key technologies/areas for the
next 10 years of Node.js

This is a first cut that the team put together. The discussion
took place in a few meetings as well as this
[PR](nodejs/next-10#11). We believe the doc
should live in the core node repository as it is intended to
reflect the agreement of the collaborator base.

I think this is a good starting point but we also
acknowledge that only a small subset of the Node.js collaborators
have participated/commented so far. This PR should be a good
way to get additional review/input from the larger set
of Node.js collaborators.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #35145
Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
@ruyadorno ruyadorno mentioned this pull request Sep 21, 2020
4 tasks
@mhdawson
Copy link
Member Author

Going to close, @GeoffreyBooth just let me know if I should do anything else to follow up on your comments.

@mhdawson mhdawson closed this Sep 21, 2020
addaleax pushed a commit that referenced this pull request Sep 22, 2020
As part of the [next-10](https://github.com/nodejs/next-10) we found
we needed to capture the project's technical values/priorities as
a starting point before discussing key technologies/areas for the
next 10 years of Node.js

This is a first cut that the team put together. The discussion
took place in a few meetings as well as this
[PR](nodejs/next-10#11). We believe the doc
should live in the core node repository as it is intended to
reflect the agreement of the collaborator base.

I think this is a good starting point but we also
acknowledge that only a small subset of the Node.js collaborators
have participated/commented so far. This PR should be a good
way to get additional review/input from the larger set
of Node.js collaborators.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #35145
Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
@codebytere codebytere mentioned this pull request Sep 28, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
As part of the [next-10](https://github.com/nodejs/next-10) we found
we needed to capture the project's technical values/priorities as
a starting point before discussing key technologies/areas for the
next 10 years of Node.js

This is a first cut that the team put together. The discussion
took place in a few meetings as well as this
[PR](nodejs/next-10#11). We believe the doc
should live in the core node repository as it is intended to
reflect the agreement of the collaborator base.

I think this is a good starting point but we also
acknowledge that only a small subset of the Node.js collaborators
have participated/commented so far. This PR should be a good
way to get additional review/input from the larger set
of Node.js collaborators.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: nodejs#35145
Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
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.