...
| Question | Description | Sample Answer | ||
Basics: IdentificationBasics: Prerequisites | ||||
| . . . | The questions in these Basics sections will be filled in automatically. | |||
| Question | Description | Sample Answer | ||
Basics: Basic project website content | ||||
| The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements] | ONAP has Developer Best Practices, so click on Met and add a reference. | |||
| Question | Description | Sample Answer | ||
Basics: Project oversight | ||||
| The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco] | This question can be answered the same ONAP-wide. | ONAP requires both a Developer Certificate of Origin (DCO), and a Contributor License Agreement (CLA). | ||
| The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance] | This question can be answered the same ONAP-wide. | The project governance is described at https://wiki.onap.org/display/DW/Community+Offices+and+Governance | ||
| The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct] | TBD | |||
| The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities] | This question can be answered the same ONAP-wide. | The key roles in the project and their responsibilities are described at https://wiki.onap.org/display/DW/Community+Offices+and+Governance | ||
| The project MUST be able to continue with minimal interruption if any one person is incapacitated or killed. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation that an individual is incapacitated or killed. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity] | ONAP uses the Linux Foundation structure to support all projects, including all keys and passwords. Nothing, including all legal rights, is invested in any single person. | TBD | ||
| The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor] | TBD | |||
| Question | Description | Sample Answer | ||
Basics: Documentation | ||||
| The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start] | TBD DOES THIS EXIST FOR ONAP? | |||
| The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current] | TBD | |||
| The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements] | Add the image for your project's CII badge to your projects's readme.io documentation. Each project is assigned a CII identifier (for example, CLAMP has a CII identifier of 1197). The image URL would be: https://bestpractices.coreinfrastructure.org/projects/1197/badge (using your project's CII identifier instead of 1197).After doing so, click Met. | The badge is visible on the project's readme.io page found at ... | ||
| Question | Description | Sample Answer | ||
Basics: Accessibility and internationalization | ||||
| The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices] | TBD DO WE HAVE A POLICY ON THIS? | |||
| The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization] | TBD | |||
| Question | Description | Sample Answer | ||
Basics: Other | ||||
| If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., PBKDF2, Bcrypt or Scrypt). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security] | TBD | |||
| Question | Description | Sample Answer | ||
Change Control: Previous versions | ||||
| The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update] | TBD | |||
| Question | Description | Sample Answer | ||
Reporting: Bug-reporting process | ||||
| The project MUST use an issue tracker for tracking individual issues. [report_tracker] | This is a question that changed from a SHOULD in the previous level to a MUST at this level. ONAP uses JIRA, so click Met. (It should be filled in already from the previous level.) | Jira is used to track issues. https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA | ||
| Question | Description | Sample Answer | ||
Change Control: Vulnerability report process | ||||
| The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit] | TBD | |||
| The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process] | TBD WHERE IS THIS DOCUMENTED? | |||
| Question | Description | Sample Answer | ||
Quality: Coding standards | ||||
| The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced] | TBD | |||
| Question | Description | Sample Answer | ||
Quality: Working build systemQuality: Installation systemQuality: Externally-maintained componentsQuality: Automated test suiteQuality: New functionality testingQuality: Warning flags | . . . | The questions in the Security section must be individually answered according to your project. | ||
| . . . | ||||
| Question | Description | Sample Answer | ||
Security: Secure development knowledgeSecurity: Use basic good cryptographic practicesSecurity: Secure releaseSecurity: Other security issues | . . . | The questions in the Security section must be individually answered according to your project. | ||
. . . | ||||
| Question | Description | Sample Answer | ||
Analysis: Static code analysisAnalysis: Dynamic code analysis | Description | Sample Answer | ||
| . . . | The questions in the Analysis section must be individually answered according to your project. |
...
| Question | Description | Sample Answer | ||
Basics: IdentificationBasics: PrerequisitesBasics: Project oversightBasics: Other | . . . | The questions in these Basics sections will be filled in automatically. Some questions change SHOULDs from previous levels to MUSTs. | ||
| Question | Description | Sample Answer | ||
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). [repo_distributed] | This question will be filled in automatically from previous levels. | |||
| The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks] | TBD DO WE HAVE POLICIES ON THIS? | |||
| 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. [require_2FA] | TBD DO WE HAVE POLICIES ON THIS? | |||
| 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. [secure_2FA] | TBD DO WE HAVE POLICIES ON THIS? | |||
| Question | Description | Sample Answer | ||
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) [code_review_standards] | TBD DO WE HAVE POLICIES ON THIS? | |||
| 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 [two_person_review] | ONAP requires a committer other than the submitter to review each proposed modification. WHERE IS THIS DOCUMENTED? | |||
| Question | Description | Sample Answer | ||
Quality: Working build system | ||||
| The project MUST have a reproducible build. 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) [build_reproducible] | TBD AFAIK, WE DO NOT CURRENTLY HAVE A POLICY ON THIS | |||
| Question | Description | Sample Answer | ||
Quality: Automated test suite | ||||
| . . . | These questions will be filled in automatically from previous levels. | |||
| Question | Description | Sample Answer | ||
Security: Use basic good cryptographic practicesSecurity: Secured delivery against man-in-the-middle (MITM) attacksSecurity: Publicly known vulnerabilities fixed | . . .These questions will be filled in automatically from previous levels. | |||
| Question | Description | Sample Answer | ||
Analysis: Dynamic code analysis | . . .Some questions in the Analysis section will be automatically filled in from previous levels. The remaining questions in the Analysis section must be individually answered according to your project. |
Sample Testing tools
The following is a list of some of the testing tools available. These may be considered for evaluation vis-a-vis the specific project requirements
...