-
-
Notifications
You must be signed in to change notification settings - Fork 129
CII-Best-Practices for Nodejs: Gold level #956
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
5d3fba7
d936238
92588d0
ba689e7
871db48
58a0411
19aab9f
e0fd2db
d36c6e0
5a25aa4
702f6d3
af5c87c
58b4364
5e75801
0d60f62
676d31e
1feeaa8
4934f98
66c2f34
da57efe
0cfdca9
f639ecb
3f496a8
91f35e7
10f6219
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,152 @@ | ||
Check the official [report](https://bestpractices.coreinfrastructure.org/en/projects/29?criteria_level=2) as some questions include additional information that might be relevant to understand the context around the question. | ||
|
||
|
||
# Basics | ||
> What is the human-readable name of the project? | ||
|
||
Node.js | ||
|
||
> What is a brief description of the project? | ||
|
||
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine | ||
|
||
> What is the URL for the project (as a whole)? | ||
|
||
https://nodejs.org | ||
|
||
> What is the URL for the version control repository (it may be the same as the project URL)? | ||
|
||
https://github.com/nodejs/node | ||
|
||
## Prerequisites | ||
|
||
> The project MUST achieve a silver level badge. | ||
|
||
**Unmet** | ||
|
||
|
||
## Project oversight | ||
|
||
> The project MUST have a "bus factor" of 2 or more. (URL required) | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST have at least two unassociated significant contributors. | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Other | ||
|
||
> The project MUST include a copyright statement in each source file, identifying the copyright holder (e.g., the [project name] contributors). | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project](https://spdx.dev/ids/#how) | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# Change Control | ||
|
||
## Public version-controlled source repository | ||
|
||
> The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# Quality | ||
|
||
## Coding standards | ||
|
||
> The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. (URL required) | ||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Working build system | ||
|
||
> The project MUST have a [reproducible build](https://reproducible-builds.org/). If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) | ||
|
||
_Possible answers: Met/Unmet/NA_ | ||
|
||
|
||
## Automated test suite | ||
|
||
|
||
> A test suite MUST be invocable in a standard way for that language. | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. | ||
|
||
**Met** | ||
https://ci.nodejs.org/ | ||
|
||
> The project MUST have FLOSS automated test suite(s) that provide at least 90% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Check if we met the 90% percentage. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've no idea if https://app.codecov.io/gh/nodejs/node is able to show statement coverage (it's showing line coverage). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I created this issue to follow up with the discussion. #1188 |
||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> The project MUST have FLOSS automated test suite(s) that provide at least 80% branch coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We need to check it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I created this issue to follow up with the discussion. #1188 |
||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
|
||
# Security | ||
|
||
## Use basic good cryptographic practices | ||
|
||
_Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of [Understanding Open Source Technology & US Export Controls](https://www.linuxfoundation.org/resources/publications/understanding-us-export-controls-with-os-projects/)._ | ||
|
||
> The software produced by the project MUST support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 MUST be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). | ||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
|
||
> The software produced by the project MUST, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). | ||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
|
||
|
||
## Secured delivery against man-in-the-middle (MITM) attacks | ||
|
||
> The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We need to understand it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I created this issue to follow up with the discussion. #1190 |
||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Other security issues | ||
|
||
> The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. | ||
|
||
_Possible answers: Met/Unmet_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> Hardening mechanisms MUST be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. (URL required) | ||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
|
||
# Analysis | ||
|
||
> The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. | ||
|
||
**Unmet** | ||
Infrastructure for running several different dynamic analysis tools is provided by the project. See: https://github.com/nodejs/node/tree/master/tools | ||
|
||
|
||
> The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. | ||
|
||
_Possible answers: Met/Unmet/NA_ | ||
UlisesGascon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Uh oh!
There was an error while loading. Please reload this page.