-
-
Notifications
You must be signed in to change notification settings - Fork 28
doc: add initial version of values and prios doc #11
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
Merged
Merged
Changes from 39 commits
Commits
Show all changes
40 commits
Select commit
Hold shift + click to select a range
2a79cc9
doc: add initial version of values and prios doc
mhdawson 18c3d7b
squash: formatting fixup
mhdawson a2827f0
Formatting fixup
mhdawson ace698b
squash: add some clarification on priorities
mhdawson 0101bc8
Update VALUES_AND_PRIORITIZAION.md
mhdawson f424184
Update VALUES_AND_PRIORITIZAION.md
mhdawson 88e73a8
Update VALUES_AND_PRIORITIZAION.md
mhdawson 29b4066
Update VALUES_AND_PRIORITIZAION.md
mhdawson 15d6f57
Update VALUES_AND_PRIORITIZAION.md
mhdawson 83bd288
Update VALUES_AND_PRIORITIZAION.md
mhdawson b8c6cba
Update VALUES_AND_PRIORITIZAION.md
mhdawson 6e6dc43
Update VALUES_AND_PRIORITIZAION.md
mhdawson 03180ce
Update VALUES_AND_PRIORITIZAION.md
mhdawson 1b9add1
Update VALUES_AND_PRIORITIZAION.md
mhdawson 4ca03bd
Update VALUES_AND_PRIORITIZAION.md
mhdawson a9b1572
Update VALUES_AND_PRIORITIZAION.md
mhdawson 5cd7b42
Update VALUES_AND_PRIORITIZAION.md
mhdawson 0c5a689
Update VALUES_AND_PRIORITIZAION.md
mhdawson 430ff3d
Update VALUES_AND_PRIORITIZAION.md
mhdawson d969782
Update VALUES_AND_PRIORITIZAION.md
mhdawson 0ffe41b
Update VALUES_AND_PRIORITIZAION.md
mhdawson fd78408
Update VALUES_AND_PRIORITIZAION.md
mhdawson eb154e6
Update VALUES_AND_PRIORITIZAION.md
mhdawson bed1422
Update VALUES_AND_PRIORITIZAION.md
mhdawson a3920d7
Update VALUES_AND_PRIORITIZAION.md
mhdawson 0e7f503
Update VALUES_AND_PRIORITIZAION.md
mhdawson b10b7e2
Update VALUES_AND_PRIORITIZAION.md
mhdawson 0ecf049
Update VALUES_AND_PRIORITIZAION.md
mhdawson da15225
Update VALUES_AND_PRIORITIZAION.md
mhdawson d7823b9
Update VALUES_AND_PRIORITIZAION.md
mhdawson ade5e1d
Update VALUES_AND_PRIORITIZAION.md
mhdawson c295415
Update VALUES_AND_PRIORITIZAION.md
mhdawson 79e1547
Update VALUES_AND_PRIORITIZAION.md
mhdawson 523199a
Update VALUES_AND_PRIORITIZAION.md
mhdawson 9705794
address comments
mhdawson 994da56
address comments
mhdawson 7bded33
fix up bullet formatting
mhdawson 34690ea
fixup
mhdawson 324a474
Update VALUES_AND_PRIORITIZAION.md
mhdawson 411d080
Update VALUES_AND_PRIORITIZAION.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # Values and Priorities | ||
|
|
||
| > Document Status: Proposal, Work In Progress | ||
|
|
||
| ## Context | ||
|
|
||
| Prioritize the **Technical** values shared by the project and use these to guide us when making tradeoffs. | ||
|
|
||
|
|
||
| ## Values and priority level | ||
|
|
||
| This is only a subset of the overall priorities, listing only those which are at the | ||
| top of the priority list. Anything on this list is very important for the project | ||
| despite the relative priorities shown. | ||
|
|
||
| - 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 | ||
|
|
||
| ### 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 | ||
|
|
||
| ### Stability | ||
| To avoid introducing churn into Node.js' ecosystem, we value stability and consistency across releases and avoid breaking changes. Some key elements of this include: | ||
| - Backwards compatibility | ||
| - Predictable and stable releases | ||
| A strong safety net, including explicitly testing how changes in Node.js affect userland packages. | ||
| - Careful consideration of what goes into LTS releases | ||
|
|
||
| ### Operational Qualities | ||
| We value keeping Node.js safe, performant and lightweight as well as the ability to investigate and debug problems in development and production. Some key elements of this include: | ||
| - Throughput (speed) | ||
| - Startup time | ||
| - Binary size | ||
| - Memory footprint | ||
| - Debug tooling (debugger) | ||
| - Diagnostic tooling (profilers, heapdumps, coredumps, etc.) | ||
| - Addressing security vulnerabilities in a responsible manner | ||
|
|
||
| ### Node.js Maintainer Experience | ||
| We value the productivity and happiness of 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 | ||
|
|
||
| ### Providing modern APIs and Technologies | ||
| 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 | ||
|
|
||
| ## References | ||
|
|
||
| [First pass at list of values](https://github.com/nodejs/next-10/issues/5) | ||
| [Original priorities brainstorm document](https://docs.google.com/document/d/1sbO_zCn9n_JH2zuGtqNAahUhA_mGFA89DdAme8nEdsw) | ||
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.