-
-
Notifications
You must be signed in to change notification settings - Fork 34.2k
doc: add technical values document #35145
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
Closed
Closed
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
90b77ca
doc: add technical values document
mhdawson f92d1bd
fixup! doc: add technical values document
Trott d52db1d
Update doc/guides/technical-values.md
mhdawson e27b301
Update doc/guides/technical-values.md
mhdawson b1c87de
Update doc/guides/technical-values.md
mhdawson ac3fef8
squash: address comments
mhdawson 3bc5746
Update doc/guides/technical-values.md
mhdawson 5cdf202
Update doc/guides/technical-values.md
mhdawson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Technical values and priorities | ||
|
|
||
| The project uses these technical values to establish priorities and guide | ||
| collaboration. | ||
|
|
||
| ## Values and priority level | ||
|
|
||
| * Priority 1 - Developer experience | ||
| * Priority 2 - Stability | ||
| * Priority 3 - Operational qualities | ||
| * Priority 4 - Node.js maintainer experience | ||
| * Priority 5 - Technology and API currency | ||
|
|
||
| ## Value descriptions | ||
|
|
||
| ### 1 - Developer experience | ||
| We value ensuring that developers are productive and enjoy developing | ||
| with Node.js. Some key elements of this include: | ||
| * Approachability (both technical and community) | ||
| * Great documentation | ||
| * Bundling friction-reducing APIs and components, even though | ||
| they could be provided externally | ||
| * Enabling/supporting external packages to ensure overall developer experience | ||
|
|
||
| ### 2 - Stability | ||
| Whenever possible, we seek to insure that currently-working code continues to | ||
| work. We seek to keep the trust of developers and end-users. Therefore, we value | ||
| stability. | ||
| Some key elements of this include: | ||
| * Backwards compatibility | ||
| * Stable releases on a predictable schedule | ||
| * A strong safety net, including testing how changes | ||
| in Node.js affect popular packages | ||
| * Careful consideration of what goes into long term support (LTS) releases | ||
|
|
||
| ### 3 - Operational qualities | ||
| We value keeping Node.js safe, performant, and lightweight. | ||
| We value enabling the ability to investigate and debug problems in | ||
| development and production. Some key elements of this include: | ||
| * High throughput (speed) | ||
| * Fast startup | ||
| * Small binary size | ||
| * Small memory footprint | ||
| * High-quality debugging tools | ||
| * Robust diagnostic tools (profilers, etc.) | ||
| * Responsible security practices | ||
|
|
||
| ### 4 - Node.js maintainer experience | ||
| We value the productivity and happiness of the Node.js maintainers. | ||
| Some key elements of this include: | ||
| * Approachability of the codebase | ||
| * Good internal documentation and guides | ||
| * Low-friction policies and processes | ||
| * Good CI and tooling to make maintainers productive | ||
|
|
||
| ### 5 - Technology and API currency | ||
mhdawson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| We value providing developers with modern APIs and technologies | ||
| following existing standards whenever possible. | ||
| Some key elements of this include: | ||
| * Participating in standards work and organizations | ||
| * Web API compatibility | ||
| * Supporting and exposing new technologies and standards through early adoption | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.