doc: add initial version of values and prios doc #11
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. | ||||||
|
|
||||||
| - Prio 1 - Developer experience | ||||||
| - Prio 2 - Stability | ||||||
| - Prio 3 - Operational qualities | ||||||
| - Prio 4 - Node.js maintainer experience | ||||||
| - Prio 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 | ||||||
|
There was a problem hiding this comment. It's kind of unclear what is meant by this There was a problem hiding this comment. What we were trying to say was that developer experience for the Node.js ecosystem is not only about the APIs provided directly by Node.js itself but also those provided by external packages as well. In that context it is important to provide APIs, or whatever else is needed to support external packages in helping the overall developer experience. Any suggestions on how to better capture that that they short version we had? There was a problem hiding this comment. maybe something like "Enable better developer experiences in packages and applications built upon Node.js"? |
||||||
|
|
||||||
| ### 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 (testing etc.) | ||||||
|
There was a problem hiding this comment. (if this is indeed what you mean):
Suggested change
There was a problem hiding this comment. @boneskull how about 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.