Cll Best Practices Badge Program "passing" checklist

[egpbos]

Following #41, in this issue we can check off the items on the CII checklist.

Once we are done, we should add the badge to the readme, so that'll be checkmark number 1:

• Add "passing" badge to readme when done!

Basics

Basic project website content

• The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good] --> Create introduction text for the repo #84
• The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact] --> add contributing instructions #96
• The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) {Met URL} [contribution] --> add contributing instructions #96
• The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). {Met URL} [contribution_requirements] --> add contributing instructions #96

FLOSS license

• The software produced by the project MUST be released as FLOSS. [floss_license]
• It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]
• The project MUST post the license(s) of its results in a standard location in their source repository. {Met URL} [license_location]

Documentation

• The project MUST provide basic documentation for the software produced by the project. {N/A justification} [documentation_basics]
• The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. {N/A justification} [documentation_interface] --> Add reference documentation #99

Other

• The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]
• The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]
• The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]
• The project MUST be maintained. [maintained]

Change Control

Public version-controlled source repository

• The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]
• The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]
• To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]
• It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

Unique version numbering

• The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique] --> Versioning, releasing, DOI, Zenodo #94
• It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver] --> Versioning, releasing, DOI, Zenodo #94
• It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags] --> Versioning, releasing, DOI, Zenodo #94

Release notes

• The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". {N/A justification} {Met URL} [release_notes] --> Versioning, releasing, DOI, Zenodo #94
• The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. {N/A justification} [release_notes_vulns] --> Versioning, releasing, DOI, Zenodo #94

Reporting

Bug-reporting process

• The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). {Met URL} [report_process]
• The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]
• The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]
• The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]
• The project MUST have a publicly available archive for reports and responses for later searching. {Met URL} [report_archive]

Vulnerability report process

• The project MUST publish the process for reporting vulnerabilities on the project site. {Met URL} [vulnerability_report_process]
• If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. {N/A allowed} {Met URL} [vulnerability_report_private]
• The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. {N/A allowed} [vulnerability_report_response]

Quality

Working build system

• If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. {N/A allowed} [build]
• It is SUGGESTED that common tools be used for building the software. {N/A allowed} [build_common_tools]
• The project SHOULD be buildable using only FLOSS tools. {N/A allowed} [build_floss_tools]

Automated test suite

• The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]
• A test suite SHOULD be invocable in a standard way for that language. [test_invocation]
• It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]
• It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

New functionality testing

• The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]
• The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]
• It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

Warning flags

• The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. {N/A allowed} [warnings]
• The project MUST address warnings. {N/A allowed} [warnings_fixed]
• It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. {N/A allowed} [warnings_strict]

Security

Secure development knowledge

• The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]
• At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

Use basic good cryptographic practices

Not applicable.

Secured delivery against man-in-the-middle (MITM) attacks

• The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]
• A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

Publicly known vulnerabilities fixed

• There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]
• Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

Other security issues

• The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

Analysis

Static code analysis

Not applicable

Dynamic code analysis

• It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]
• [N/A] It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). {N/A allowed} [dynamic_analysis_unsafe]
• It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]
• [N/A] All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. {N/A allowed} [dynamic_analysis_fixed]

[egpbos]

The items under [version] and [release] will be fulfilled with #94 and PR #98.

[egpbos]

I checked the items under vulnerability reports, but really they are the same as the bug reports, since we have no security risks to speak of.

[egpbos]

Working build system: N/A.

[egpbos]

For the "New functionality testing": I added an item to the PR checklist in #98.

[egpbos]

I think, as with vulnerability reports, the "Secure development knowledge" part is overkill for this project (and probably for most research software). I'll just check them, since I think the things listed there are not rocket science, so technically we fulfill the criteria.

[egpbos]

Static code analysis: also not applicable.

[egpbos]

Okay! So, all the items that are not yet checked now have a separate issue.

... except the following two under bug fixing:

• The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]
• The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

I'm not sure we can (or want to) guarantee this. On the other hand, it seems unlikely that it will become an actual issue in the near future, since we have no users, except ourselves.

What do you guys think? @bhigy @cwmeijer

[bhigy]

That might change as the repo is used for the ZeroSpeech challenge - Multimodal track, that will be announced soon. I am not so kin on formalizing any such guarantee though as it is indeed not clear how we could ensure that once the project ends.