Note this is a long-term goal, see https://www.bestpractices.dev/en/criteria for all details but this is a summary of where we are. Once we have passed Basic, we would also pass most but not quite all criteria for Silver.

Basics

Basic project website content

[X] - The project website MUST describe what the software does [X] - The project website MUST provide information on how to provide feedback and contribute. [X] - The information MUST explain the contribution process. [X] - The information SHOULD include the requirements for acceptable contributions

FLOSS license

[X] - The software produced by the project MUST be released as FLOSS. [X] - It is SUGGESTED that any required license(s) is OSI-approved. [X] - The project MUST post the license(s) in the source repository.

Documentation

[X] - The project MUST provide basic documentation. [X] - The project MUST provide documentation that describes the external interface.

Other

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

Change Control

Public version-controlled source repository

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

Unique version numbering

[X] -The project results MUST have a unique version identifier for each release intended to be used by users. [ ] - It is SUGGESTED that the Semantic Versioning be used for releases. [X] - It is SUGGESTED that projects identify each release within their version control system.

Release notes

[X] - The project MUST provide, in each release, release notes that are a human-readable summary of major changes. [ ] - The release notes MUST identify every publicly known run-time vulnerability fixed in this release.

Reporting

Bug-reporting process

[X] - The project MUST provide a process for users to submit bug reports [X] - The project SHOULD use an issue tracker for tracking individual issues. [ ] - The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive). [ ] - The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [X] - The project MUST have a publicly available archive for reports and responses for later searching.

Vulnerability report process

[X] -The project MUST publish the process for reporting vulnerabilities on the project site. [ ] - 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.

Quality

Working build system

[X] - The project MUST provide a working build system that can automatically rebuild the software from source code. [X] - It is SUGGESTED that common tools be used for building the software. [X] - The project SHOULD be buildable using only FLOSS tools.

Automated test suite

[X] - The project MUST use at least one automated test suite that is publicly released as FLOSS. The project MUST clearly show or document how to run the test suite(s). [X] - A test suite SHOULD be invocable in a standard way for that language. [ ] - It is SUGGESTED that the test suite covers most (or ideally all) the code branches, input fields, and functionality. [X] - It is SUGGESTED that the project implement 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. [ ] - 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. [ ] - It is SUGGESTED that this policy on adding tests be documented in the instructions for change proposals.

Warning flags

[ ] - The project MUST enable one or more compiler warning flags. [ ] - The project MUST address warnings. [ ] - It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical.

Security

Secure development knowledge

[ ] - The project MUST have at least one primary developer who knows how to design secure software. [ ] - 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.

Use basic good cryptographic practices

See https://www.bestpractices.dev/en/criteria

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. [ ] - A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http.

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. [ ] - Projects SHOULD fix all critical vulnerabilities rapidly after they are reported.

Other security issues

[ ] - The public repositories MUST NOT leak a valid private credential.

Analysis

Static code analysis

[ ] - At least one static code analysis tool MUST be applied to any proposed major production release of the software before its release. [ ] - It is SUGGESTED that at least one of the static analysis tools is used to look for common vulnerabilities in the analyzed language or environment. [ ] - All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [ ] - It is SUGGESTED that static source code analysis occur on every commit or at least daily.

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. [ ] - It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing). [ ] - All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed.

apache / gravitino

[Improvement] Get best practices basic badge #662