...
| 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 Further information can be found at https://wiki.onap.org/display/DW/ONAP+Technical+Community+Document | |
| The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct] | TBD: TODO:Arul Need to create a ONAP-wide page which will describe the | ||
| 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 Current members are listed at | |
| 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. | For AAI-UI we have 4 committers and multiple contributes who are listed in | |
| The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor] | All the projects covered in this report have more than 2 persons who actively contribute and maintain code. | ||
| 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] | Road map for AAI can be found in | ||
| 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] | Architecture of AAI can be found in https://wiki.onap.org/pages/viewpage.action?pageId=1015836 | ||
| 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? TODO:Arul I think we need to come up with a ONAP-Wide page where we have listed the steps that the seccom team has taken to make sure that ONAP is secure. https://docs.zephyrproject.org/latest/security/security-overview.html | ||
| 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] | This question can be answered the same ONAP-wide. | Information on setting up ONAP can be found at https://onap.readthedocs.io/en/latest/guides/onap-developer/settingup/index.html | |
| 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] | Documentation is updated on a regular bases when needed. | ||
| 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] | What is neededYou will have to add the image and the link to the CII badging to your projects. Both you will need your project-idenfier information for that. How to retrieve your project identifiereg for the project AAI-UI the CII link is https://bestpractices.coreinfrastructure.org/projects/1737 And the project identifier is 1737 How to generate 2 urlsTo add the link and image you will need 2 URL's both are relative to your specific project eg Image: https://bestpractices.coreinfrastructure.org/projects/1737/badge Link: https://bestpractices.coreinfrastructure.org/projects/1737 Examples for diff types of readmeOnce you have this information you will need to add them to your readme file. The readme files are in different formats. Examples for *.MD and *.rst are follows *.MD:[](https://bestpractices.coreinfrastructure.org/projects/1737) *.rst.. image:: https://bestpractices.coreinfrastructure.org/projects/1737/badge 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] | Any UI based project should would need to consider Accessibility and internalization. Resourceshttp://brebru.com/css/accessibility.html https://achecker.ca/checker/index.php | The following projects do not have any use interface of input field. They all expose API's and fulfill a contract https://gerrit.onap.org/r/gitweb?p=aai/router-core.git;a=blob;f=License.txt;h=c97ccb2ef72c2f18a5299fa8e8c380e01fcc109a;hb=refs/heads/master | |
| 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] | The following projects do not have any use interface of input field. They all expose API's and fulfill a contract https://gerrit.onap.org/r/gitweb?p=aai/router-core.git;a=blob;f=License.txt;h=c97ccb2ef72c2f18a5299fa8e8c380e01fcc109a;hb=refs/heads/master | ||
| 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] | The project does not store password in the website, repository or downloads. | ||
| 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] | All major releases are tagged in gerrit and the artifacts are stored with the release information on onap.nexus. So we can access all old versions of the artifact. If and when a upgrade requires certain steps to be followed they are being added to the release documents as needed | ||
| 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] | ONAP-Wide | Vulnerabilities can be reported using the link | |
| The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process] | ONAP-WIDE | Vulnerabilities handling is documented in | |
| 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?ONAP-WIDE | Coding style is defined in | |
| 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] | TBDFor sparky-fe we use eslint to force code styling. | ||
| Question | Description | Sample Answer | |
Quality: Working build system | |||
| Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables] | The application does not create native binaries. (Some of the libraries it depends on do, but those are external.) | ||
| The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A).[build_preserve_debug] | The application does not create native binaries. (Some of the libraries it depends on do, but those are external.) | ||
| The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive] | The application does not create native binaries. (Some of the libraries it depends on do, but those are external.) | ||
| The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable] | All releases are tagged in gerrit(git), and the builds are controlled using jenkins. By providing the git tag information the same image can be build over and over again with same bit-for-bit result. | ||
Quality: Installation system | |||
| The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common] | All packages are delivered either as an jar artifact or a docker image. | ||
| The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). | The compiled docker images and jar files can be installed/used as the user sees fit. Both run on JVM or docker. So there is no reason to selecting locations etc. | ||
| The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick] | All the components require only java and maven to begin with for a developer to quickly install and test it. | ||
Quality: Externally-maintained components | |||
| The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies] | External dependencies are controlled using the pom file, which can be found in the root folder for the projects https://gerrit.onap.org/r/gitweb?p=aai/sparky-be.git;a=tree;h=refs/heads/master;hb=refs/heads/master | ||
| Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring] | Nexus sonar scan is run on all the projects on a weekly basis | ||
The project MUST either:
| External components are maintained through Maven. The user can get a list of all included components using the maven dependency tree and can update or reuse as they see fit | ||
| The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current] | We avoid depending on deprecated/obsolete functions. | ||
Quality: Automated test suite | |||
| An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing] | Automatic test suites are run every time before merging the code. The code check in cannot pass with out jenkins posting a +1 on the review. | ||
| The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. | When regressions occur, we add tests for them. | ||
| The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80] | We use sonar to measure the code coverage. | ||
Quality: New functionality testing | |||
The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated] | Contributing guide lines for development is recorded in | ||
| The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added] | This is documented on our wiki: Code Coverage and Static Code Analysis | ||
Quality: 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 | The questions in the Analysis section must be individually answered according to your project. | Sample Answer |
...