ruview-home-assistant

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 15577 is passing Here is how to embed it:
You can show your badge status by embedding this in your markdown file:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/15577/badge)](https://www.bestpractices.dev/projects/15577)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/15577"><img src="https://www.bestpractices.dev/projects/15577/badge"></a>


These are the Silver level criteria. You can also view the Passing or Gold level criteria.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics 16/17 ●

  • General

    Note that other projects may use the same name.

    Experimental freshness-gated RuView observations for Home Assistant MQTT discovery

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    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]

    Public GitHub issues and pull requests are the documented English collaboration channel; contribution rights, test/review rules and privacy requirements are stated. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/CONTRIBUTING.md


  • Project oversight


    Barely enough for a badge.

    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]
    The DCO is the recommended mechanism because it's easy to implement, tracked in the source code, and git directly supports a "signed-off" feature using "commit -s". To be most effective it is best if the project documentation explains what "signed-off" means for that project. A CLA is a legal agreement that defines the terms under which intellectual works have been licensed to an organization or project. A contributor assignment agreement (CAA) is a legal agreement that transfers rights in an intellectual work to another party; projects are not required to have CAAs, since having CAA increases the risk that potential contributors will not contribute, especially if the receiver is a for-profit organization. The Apache Software Foundation CLAs (the individual contributor license and the corporate CLA) are examples of CLAs, for projects which determine that the risks of these kinds of CLAs to the project are less than their benefits.

    The complete evidence required for dco has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]
    There needs to be some well-established documented way to make decisions and resolve disputes. In small projects, this may be as simple as "the project owner and lead makes all final decisions". There are various governance models, including benevolent dictator and formal meritocracy; for more details, see Governance models. Both centralized (e.g., single-maintainer) and decentralized (e.g., group maintainers) approaches have been successfully used in projects. The governance information does not need to document the possibility of creating a project fork, since that is always possible for FLOSS projects.

    The governance document assigns contributor, maintainer and automation duties and explains decisions, reviews and security/release responsibility. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/GOVERNANCE.md


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]
    Projects may be able to improve the civility of their community and to set expectations about acceptable conduct by adopting a code of conduct. This can help avoid problems before they occur and make the project a more welcoming place to encourage contributions. This should focus only on behavior within the community/workplace of the project. Example codes of conduct are the Linux kernel code of conduct, the Contributor Covenant Code of Conduct, the Debian Code of Conduct, the Ubuntu Code of Conduct, the Fedora Code of Conduct, the GNOME Code Of Conduct, the KDE Community Code of Conduct, the Python Community Code of Conduct, The Ruby Community Conduct Guideline, and The Rust Code of Conduct.

    Expected behavior, prohibited harassment, private contact, enforcement and reconsideration are defined, with the independent-moderator limitation disclosed. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/CODE_OF_CONDUCT.md


    Enough for a badge!

    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]
    The documentation for governance and roles and responsibilities may be in one place.

    The governance document assigns contributor, maintainer and automation duties and explains decisions, reviews and security/release responsibility. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/GOVERNANCE.md


    Not enough for a badge.

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. 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 of the loss of support from any one individual. 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]

    The maintainer confirms no backup person or tested one-week recovery process for repository, CI and release access. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/GOVERNANCE.md


    Barely enough for a badge.

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]
    A "bus factor" (aka "truck factor") is the minimum number of project members that have to suddenly disappear from a project ("hit by a bus") before the project stalls due to lack of knowledgeable or competent personnel. The truck-factor tool can estimate this for projects on GitHub. For more information, see Assessing the Bus Factor of Git Repositories by Cosentino et al.

    The maintainer confirms no backup person or tested one-week recovery process for repository, CI and release access. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/GOVERNANCE.md


  • Documentation


    Enough for a badge!

    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]
    The project might not achieve the roadmap, and that's fine; the purpose of the roadmap is to help potential users and contributors understand the intended direction of the project. It need not be detailed.

    A project-specific October 2026–October 2027 roadmap states planned work and non-goals without claiming delivery. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/ROADMAP.md


    Enough for a badge!

    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]
    A software architecture explains a program's fundamental structures, i.e., the program's major components, the relationships among them, and the key properties of these components and relationships.

    The linked architecture/interface documentation describes components, flow and operating boundaries. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/python-api.md


    Enough for a badge!

    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]
    These are the security requirements that the software is intended to meet.

    The security guide explains transport or local-data boundaries, reporting and maintenance. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/SECURITY.md


    Enough for a badge!

    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]
    The idea is to show users how to get started and make the software do anything at all. This is critically important for potential users to get started.

    README and contributor instructions give supported prerequisites, installation examples and development/test commands. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md


    Enough for a badge!

    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]
    The documentation MAY include information about differences or changes between versions of the software and/or link to older versions of the documentation. The intent of this criterion is that an effort is made to keep the documentation consistent, not that the documentation must be perfect.

    README and contributor instructions give supported prerequisites, installation examples and development/test commands. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md


    Enough for a badge!

    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]
    An achievement is any set of external criteria that the project has specifically worked to meet, including some badges. This information does not need to be on the project website front page. A project using GitHub can put achievements on the repository front page by adding them to the README file.

    README links the live registered assessment; governance requires recognition updates within 48 hours. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md


  • Accessibility and internationalization


    Barely enough for a badge.

    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]
    For web applications, see the Web Content Accessibility Guidelines (WCAG 2.0) and its supporting document Understanding WCAG 2.0; see also W3C accessibility information. For GUI applications, consider using the environment-specific accessibility guidelines (such as Gnome, KDE, XFCE, Android, iOS, Mac, and Windows). Some TUI applications (e.g. `ncurses` programs) can do certain things to make themselves more accessible (such as `alpine`'s `force-arrow-cursor` setting). Most command-line applications are fairly accessible as-is. This criterion is often N/A, e.g., for program libraries. Here are some examples of actions to take or issues to consider:
    • Provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols or simpler language ( WCAG 2.0 guideline 1.1)
    • Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. ( WCAG 2.0 guideline 1.4.1)
    • The visual presentation of text and images of text has a contrast ratio of at least 4.5:1, except for large text, incidental text, and logotypes ( WCAG 2.0 guideline 1.4.3)
    • Make all functionality available from a keyboard (WCAG guideline 2.1)
    • A GUI or web-based project SHOULD test with at least one screen-reader on the target platform(s) (e.g. NVDA, Jaws, or WindowEyes on Windows; VoiceOver on Mac & iOS; Orca on Linux/BSD; TalkBack on Android). TUI programs MAY work to reduce overdraw to prevent redundant reading by screen-readers.

    The complete evidence required for accessibility_best_practices has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Barely enough for a badge.

    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]
    Localization "refers to the adaptation of a product, application or document content to meet the language, cultural and other requirements of a specific target market (a locale)." Internationalization is the "design and development of a product, application or document content that enables easy localization for target audiences that vary in culture, region, or language." (See W3C's "Localization vs. Internationalization".) Software meets this criterion simply by being internationalized. No localization for another specific language is required, since once software has been internationalized it's possible for others to work on localization.

    The complete evidence required for internationalization has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


  • Other


    Enough for a badge!

    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., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]
    Note that the use of GitHub meets this criterion. This criterion only applies to passwords used for authentication of external users into the project sites (aka inbound authentication). If the project sites must log in to other sites (aka outbound authentication), they may need to store authorization tokens for that purpose differently (since storing a hash would be useless). This applies criterion crypto_password_storage to the project sites, similar to sites_https.

    Official source/collaboration hosting is GitHub; no separate project-managed web-account password service is operated. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md


 Change Control 1/1 ●

  • Previous versions


    Enough for a badge!

    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]

    The release/maintenance guide describes reviewed source updates, compatibility, validation and recovery. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/RELEASING.md


 Reporting 3/3 ●

 Quality 10/19 ●

  • Coding standards


    Not enough for a badge.

    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]
    In most cases this is done by referring to some existing style guide(s), possibly listing differences. These style guides can include ways to improve readability and ways to reduce the likelihood of defects (including vulnerabilities). Many programming languages have one or more widely-used style guides. Examples of style guides include Google's style guides and SEI CERT Coding Standards.

    The complete evidence required for coding_standards has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Not enough for a badge.

    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]
    This MAY be implemented using static analysis tool(s) and/or by forcing the code through code reformatters. In many cases the tool configuration is included in the project's repository (since different projects may choose different configurations). Projects MAY allow style exceptions (and typically will); where exceptions occur, they MUST be rare and documented in the code at their locations, so that these exceptions can be reviewed and so that tools can automatically handle them in the future. Examples of such tools include ESLint (JavaScript), Rubocop (Ruby), and devtools check (R).

    The complete evidence required for coding_standards_enforced has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


  • Working build system


    Not enough for a badge.

    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]
    It should be easy to enable special build features like Address Sanitizer (ASAN), or to comply with distribution hardening best practices (e.g., by easily turning on compiler flags to do so).

    The complete evidence required for build_standard_variables has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Barely enough for a badge.

    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]
    E.G., setting CFLAGS (C) or CXXFLAGS (C++) should create the relevant debugging information if those languages are used, and they should not be stripped during installation. Debugging information is needed for support and analysis, and also useful for measuring the presence of hardening features in the compiled binaries.

    The complete evidence required for build_preserve_debug has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Enough for a badge!

    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 project build system's internal dependency information needs to be accurate, otherwise, changes to the project may not build correctly. Incorrect builds can lead to defects (including vulnerabilities). A common mistake in large build systems is to use a "recursive build" or "recursive make", that is, a hierarchy of subdirectories containing source files, where each subdirectory is independently built. Unless each subdirectory is fully independent, this is a mistake, because the dependency information is incorrect.

    The package uses one standard setuptools build, not a recursive Make tree. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/pyproject.toml


    Not enough for a badge.

    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]
    GCC and clang users may find the -frandom-seed option useful; in some cases, this can be resolved by forcing some sort order. More suggestions can be found at the reproducible build site.

    The complete evidence required for build_repeatable has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]
    Examples include using a package manager (at the system or language level), "make install/uninstall" (supporting DESTDIR), a container in a standard format, or a virtual machine image in a standard format. The installation and uninstallation process (e.g., its packaging) MAY be implemented by a third party as long as it is FLOSS.

    README and contributor instructions give supported prerequisites, installation examples and development/test commands. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md


    Not enough for a badge.

    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). [installation_standard_variables]

    The complete evidence required for installation_standard_variables has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Enough for a badge!

    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]
    This MAY be implemented using a generated container and/or installation script(s). External dependencies would typically be installed by invoking system and/or language package manager(s), per external_dependencies.

    README and contributor instructions give supported prerequisites, installation examples and development/test commands. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]
    Typically this is done using the conventions of package manager and/or build system. Note that this helps implement installation_development_quick.

    External dependencies are machine-readable through pyproject.toml and uv.lock, including the Python floor, runtime packages, development tools and build backend. The Dockerfile pins its base digest and native security revision, and container/requirements-installer.txt pins the installer version and hash. Release-client source/module and binary hash locks are retained in scripts. Required CI now generates a complete actual-image JSON inventory and CycloneDX SBOM: the reviewed report includes 87 Debian package records and 23 Python component records, including vendored packages and duplicate project metadata; the CycloneDX document contains 111 components. This inventory claim does not assert absence of vulnerabilities or bit-for-bit build reproducibility. https://github.com/ha-homelab/ruview-home-assistant/blob/aef48f563b4658b5b0c6b8e9091d5ea69d1bb44c/pyproject.toml https://github.com/ha-homelab/ruview-home-assistant/blob/aef48f563b4658b5b0c6b8e9091d5ea69d1bb44c/uv.lock https://github.com/ha-homelab/ruview-home-assistant/blob/aef48f563b4658b5b0c6b8e9091d5ea69d1bb44c/Dockerfile https://github.com/ha-homelab/ruview-home-assistant/blob/aef48f563b4658b5b0c6b8e9091d5ea69d1bb44c/docs/quality.md https://github.com/ha-homelab/ruview-home-assistant/actions/runs/38960158445


    Not enough for a badge.

    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]
    This can be done using an origin analyzer / dependency checking tool / software composition analysis tool such as OWASP's Dependency-Check, Sonatype's Nexus Auditor, Synopsys' Black Duck Software Composition Analysis, and Bundler-audit (for Ruby). Some package managers include mechanisms to do this. It is acceptable if the components' vulnerability cannot be exploited, but this analysis is difficult and it is sometimes easier to simply update or fix the part.

    Current image and source checks monitor dependencies, and the XZ and old pip issues are fixed. Full closure is not yet claimed: the actual image still contains pip-vendored urllib3 2.7.0 with CVE-2026-97687, CVE-2026-97688 and CVE-2026-97689, published 2026-09-29 and fixed upstream in 2.8.0. Remaining recent OS findings and the separately documented recent gh findings also require continued applicability assessment or updates. Unlike the Passing 60-day criterion, this row is not marked Met merely because those disclosures are recent. Older pip-vendor findings were checked against exact shipped components and call paths, not dismissed simply because they are vendored. https://github.com/ha-homelab/ruview-home-assistant/blob/aef48f563b4658b5b0c6b8e9091d5ea69d1bb44c/docs/quality.md https://github.com/ha-homelab/ruview-home-assistant/blob/aef48f563b4658b5b0c6b8e9091d5ea69d1bb44c/docs/release-github-cli.md https://github.com/ha-homelab/ruview-home-assistant/actions/runs/38960158445 https://github.com/urllib3/urllib3/releases/tag/2.8.0


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]
    A typical way to meet this criterion is to use system and programming language package management systems. Many FLOSS programs are distributed with "convenience libraries" that are local copies of standard libraries (possibly forked). By itself, that's fine. However, if the program *must* use these local (forked) copies, then updating the "standard" libraries as a security update will leave these additional copies still vulnerable. This is especially an issue for cloud-based systems; if the cloud provider updates their "standard" libraries but the program won't use them, then the updates don't actually help. See, e.g., "Chromium: Why it isn't in Fedora yet as a proper package" by Tom Callaway.

    The dependency manifest identifies replaceable external packages; source and configuration remain editable through reviewed updates. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/pyproject.toml


    Barely enough for a badge.

    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]

    The complete evidence required for interfaces_current has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


  • Automated test suite


    Enough for a badge!

    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]
    This requirement can be viewed as a subset of test_continuous_integration, but focused on just testing, without requiring continuous integration.

    Tests execute combined security/input/output behavior with synthetic fixtures; CI runs the documented suite. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/tests/test_strict_tls.py


    Not enough for a badge.

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    The complete evidence required for regression_tests_added50 has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


    Not enough for a badge.

    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]
    Many FLOSS tools are available to measure test coverage, including gcov/lcov, Blanket.js, Istanbul, JCov, and covr (R). Note that meeting this criterion is not a guarantee that the test suite is thorough, instead, failing to meet this criterion is a strong indicator of a poor test suite.

    The complete evidence required for test_statement_coverage80 has not yet been established. This item remains open. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


  • New functionality testing


    Enough for a badge!

    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]

    All major functionality changes must include automated regression coverage and relevant negative cases. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/CONTRIBUTING.md


    Enough for a badge!

    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]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    All major functionality changes require automated regression tests, relevant negative cases and updated documentation. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/CONTRIBUTING.md


  • Warning flags


    Not enough for a badge.

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
    Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

    The current useful diagnostics do not prove maximum warning-as-error coverage over every first- and third-party language/toolchain. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/docs/quality.md


 Security 7/13 ●

 Analysis 2/2 ●

  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]
    Static analysis tools that are specifically designed to look for common vulnerabilities are more likely to find them. That said, using any static tools will typically help find some problems, so we are suggesting but not requiring this for the 'passing' level badge.

    CodeQL scans common vulnerabilities in CI; local Python checks supplement it. The security query configuration remains enabled. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/.github/workflows/security.yml


  • Dynamic code analysis


    Enough for a badge!

    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) MUST 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). [dynamic_analysis_unsafe]
    Examples of mechanisms to detect memory safety problems include Address Sanitizer (ASAN) (available in GCC and LLVM), Memory Sanitizer, and valgrind. Other potentially-used tools include thread sanitizer and undefined behavior sanitizer. Widespread assertions would also work.

    First-party application and helper sources are Python and configuration; no first-party memory-unsafe implementation is maintained. Upstream implementation code is not claimed to be locally instrumented. https://github.com/ha-homelab/ruview-home-assistant/blob/23c1a20be666a42c6023776b66345f22ed1cbdee/README.md



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/15577/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. See our automation proposals system for how to do that. This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit alvit and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: alvit.
Entry created on 2026-10-16 18:12:16 UTC, last updated on 2026-10-16 20:14:07 UTC. Last achieved passing badge on 2026-10-16 20:13:51 UTC.