KyPulse-server

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 15931 is in_progress 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/15931/badge)](https://www.bestpractices.dev/projects/15931)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/15931"><img src="https://www.bestpractices.dev/projects/15931/badge"></a>


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

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

        

 Basics 13/13 ●

  • General

    Note that other projects may use the same name.

    KyPulse: health and monitoring across your Ky products

    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.
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]
    This MUST be in language that potential users can understand (e.g., it uses minimal jargon).

    The README describes the project’s purpose and user-visible capabilities: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/README.md.



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]
    We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list (which one?)

    The contributor guide explains the pull-request workflow, expected change description and review process: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/CONTRIBUTING.md.



    The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    The contributor guide sets requirements for acceptable changes, verification, security impact and review: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/CONTRIBUTING.md.


  • FLOSS license


    The software produced by the project MUST be released as FLOSS. [floss_license]
    FLOSS is software released in a way that meets the Open Source Definition or Free Software Definition. Examples of such licenses include the CC0, MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). For our purposes, this means that the license MUST be: The software MAY also be licensed other ways (e.g., "GPLv2 or proprietary" is acceptable).

    The repository’s original project results are released under the MIT License: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/LICENSE.txt. Third-party components retain their own licenses.



    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 OSI uses a rigorous approval process to determine which licenses are OSS.

    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]
    One convention is posting the license as a top-level file named LICENSE or COPYING, which MAY be followed by an extension such as ".txt" or ".md". An alternative convention is to have a directory named LICENSES containing license file(s); these files are typically named as their SPDX license identifier followed by an appropriate file extension, as described in the REUSE Specification. Note that this criterion is only a requirement on the source repository. You do NOT need to include the license file when generating something from the source code (such as an executable, package, or container). For example, when generating an R package for the Comprehensive R Archive Network (CRAN), follow standard CRAN practice: if the license is a standard license, use the standard short license specification (to avoid installing yet another copy of the text) and list the LICENSE file in an exclusion file such as .Rbuildignore. Similarly, when creating a Debian package, you may put a link in the copyright file to the license text in /usr/share/common-licenses, and exclude the license file from the created package (e.g., by deleting the file after calling dh_auto_install). We encourage including machine-readable license information in generated formats where practical.

    The project posts its license at the conventional top-level path LICENSE.txt: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/LICENSE.txt.


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]
    This documentation must be in some media (such as text or video) that includes: how to install it, how to start it, how to use it (possibly with a tutorial using examples), and how to use it securely (e.g., what to do and what not to do) if that is an appropriate topic for the software. The security documentation need not be long. The project MAY use hypertext links to non-project material as documentation. If the project does not produce software, choose "not applicable" (N/A).

    The README provides product usage/setup information or directly links the installation and operation guides: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/README.md. Review completeness for intended users before saving.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]
    The documentation of an external interface explains to an end-user or developer how to use it. This would include its application program interface (API) if the software has one. If it is a library, document the major classes/types and methods/functions that can be called. If it is a web application, define its URL interface (often its REST interface). If it is a command-line interface, document the parameters and options it supports. In many cases it's best if most of this documentation is automatically generated, so that this documentation stays synchronized with the software as it changes, but this isn't required. The project MAY use hypertext links to non-project material as documentation. Documentation MAY be automatically generated (where practical this is often the best way to do so). Documentation of a REST interface may be generated using Swagger/OpenAPI. Code interface documentation MAY be generated using tools such as JSDoc (JavaScript), ESDoc (JavaScript), pydoc (Python), devtools (R), pkgdown (R), and Doxygen (many). Merely having comments in implementation code is not sufficient to satisfy this criterion; there needs to be an easy way to see the information without reading through all the source code. If the project does not produce software, choose "not applicable" (N/A).

    The public ingestion/monitoring reference documents pairing, bearer authentication, NDJSON inputs and limits, acknowledgement/digest/sequence outputs, pagination and HTTP error behavior. Sources: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/docs/LOG-COLLECTION.md ; https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/docs/MONITORING.md


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]
    This requires that the project home page URL and the version control repository URL begin with "https:", not "http:". You can get free certificates from Let's Encrypt. Projects MAY implement this criterion using (for example) GitHub pages, GitLab pages, or SourceForge project pages. If you support HTTP, we urge you to redirect the HTTP traffic to HTTPS.

    The identified primary project website/repository and published release-page endpoints all responded over HTTPS, with HTTPS final destinations, when checked at 2026-10-26T00:20:56.343933+00:00. Endpoints: https://github.com/Busnes-app/KyPulse-server ; https://busnes.app/kypulse.html ; https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.3.1. Local HTTP development/health examples are product operation, not project publication sites.



    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]
    Examples of acceptable mechanisms include archived mailing list(s), GitHub issue and pull request discussions, Bugzilla, Mantis, and Trac. Asynchronous discussion mechanisms (like IRC) are acceptable if they meet these criteria; make sure there is a URL-addressable archiving mechanism. Proprietary JavaScript, while discouraged, is permitted.

    Public GitHub issues and pull requests provide searchable discussion, stable URLs and participation using a browser: https://github.com/Busnes-app/KyPulse-server/issues and https://github.com/Busnes-app/KyPulse-server/pulls.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]
    English is currently the lingua franca of computer technology; supporting English increases the number of different potential developers and reviewers worldwide. A project can meet this criterion even if its core developers' primary language is not English.

    The public README and contribution instructions are in English; GitHub accepts English-language reports/comments: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/README.md and https://github.com/Busnes-app/KyPulse-server/issues.



    The project MUST be maintained. [maintained]
    As a minimum, the project should attempt to respond to significant problem and vulnerability reports. A project that is actively pursuing a badge is probably maintained. All projects and people have limited resources, and typical projects must reject some proposed changes, so limited resources and proposal rejections do not by themselves indicate an unmaintained project.

    When a project knows that it will no longer be maintained, it should set this criterion to "Unmet" and use the appropriate mechanism(s) to indicate to others that it is not being maintained. For example, use “DEPRECATED” as the first heading of its README, add “DEPRECATED” near the beginning of its home page, add “DEPRECATED” to the beginning of its code repository project description, add a no-maintenance-intended badge in its README and/or home page, mark it as deprecated in any package repositories (e.g., npm deprecate), and/or use the code repository's marking system to archive it (e.g., GitHub's "archive" setting, GitLab’s "archived" marking, Gerrit's "readonly" status, or SourceForge’s "abandoned" project status). Additional discussion can be found here.

    The primary developer is actively maintaining this project, acknowledges its reports and requests, fixes confirmed medium-or-higher security findings, and is pursuing this badge. The owner confirmed these practices while completing the Ky questionnaires. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.


 Change Control 9/9 ●

  • 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 URL MAY be the same as the project URL. The project MAY use private (non-public) branches in specific cases while the change is not publicly released (e.g., for fixing a vulnerability before it is revealed to the public).

    This repository is public and its version-controlled source is readable at https://github.com/Busnes-app/KyPulse-server/tree/56aab1c9930bbff753002e5c177fe46660cd658e.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Git tracks changes, authors and timestamps; the inspected source snapshot is commit 56aab1c9930bbff753002e5c177fe46660cd658e: https://github.com/Busnes-app/KyPulse-server/commit/56aab1c9930bbff753002e5c177fe46660cd658e.



    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]
    Projects MAY choose to omit specific interim versions from their public source repositories (e.g., ones that fix specific non-public security vulnerabilities, may never be publicly released, or include material that cannot be legally posted and are not in the final release).

    The repository contains editable source and development changes between tagged releases, rather than only release archives. Snapshot: https://github.com/Busnes-app/KyPulse-server/tree/56aab1c9930bbff753002e5c177fe46660cd658e; development history: https://github.com/Busnes-app/KyPulse-server/commits/56aab1c9930bbff753002e5c177fe46660cd658e.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]
    Git is not specifically required and projects can use centralized version control software (such as subversion) with justification.

    This project uses Git, a common distributed version-control system. Public snapshot: https://github.com/Busnes-app/KyPulse-server/tree/56aab1c9930bbff753002e5c177fe46660cd658e.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]
    This MAY be met in a variety of ways including a commit IDs (such as git commit id or mercurial changeset id) or a version number (including version numbers that use semantic versioning or date-based schemes like YYYYMMDD).

    Each observed published release has a distinct version/tag identifier. Examples: https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.3.1; https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.3; https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.2. Confirm the same rule for any distribution channel outside GitHub.



    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]
    Projects should generally prefer whatever format is expected by their users, e.g., because it is the normal format used by their ecosystem. Many ecosystems prefer SemVer, and SemVer is generally preferred for application programmer interfaces (APIs) and software development kits (SDKs). CalVer tends to be used by projects that are large, have an unusually large number of independently-developed dependencies, have a constantly-changing scope, or are time-sensitive. It is SUGGESTED that those who use CalVer include a micro level value, because including a micro level supports simultaneously-maintained branches whenever that becomes necessary. Other version numbering formats may be used as version numbers, including git commit IDs or mercurial changeset IDs, as long as they uniquely identify versions. However, some alternatives (such as git commit IDs) can cause problems as release identifiers, because users may not be able to easily determine if they are up-to-date. The version ID format may be unimportant for identifying software releases if all recipients only run the latest version (e.g., it is the code for a single website or internet service that is constantly updated via continuous delivery).

    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]
  • 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". (URL required) [release_notes]
    The release notes MAY be implemented in a variety of ways. Many projects provide them in a file named "NEWS", "CHANGELOG", or "ChangeLog", optionally with extensions such as ".txt", ".md", or ".html". Historically the term "change log" meant a log of every change, but to meet these criteria what is needed is a human-readable summary. The release notes MAY instead be provided by version control system mechanisms such as the GitHub Releases workflow.

    Each observed GitHub release includes human-readable notes describing changes, rather than raw git-log output. Examples: https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.3.1; https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.3; https://github.com/Busnes-app/KyPulse-server/releases/tag/v0.4.2. Review coverage of all user-facing releases before saving.



    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. [release_notes_vulns]
    This criterion helps users determine if a given update will fix a vulnerability that is publicly known, to help users make an informed decision about updating. If users typically cannot practically update the software themselves on their computers, but must instead depend on one or more intermediaries to perform the update (as is often the case for a kernel and low-level software that is intertwined with a kernel), the project may choose "not applicable" (N/A) instead, since this additional information will not be helpful to those users. Similarly, a project may choose N/A if all recipients only run the latest version (e.g., it is the code for a single website or internet service that is constantly updated via continuous delivery). This criterion only applies to the project results, not its dependencies. Listing the vulnerabilities of all transitive dependencies of a project becomes unwieldy as dependencies increase and vary, and is unnecessary since tools that examine and track dependencies can do this in a more scalable way.

    On 2026-10-25, the primary developer and project owner Yoshiofthewire reported no known publicly disclosed Ky product vulnerabilities with a CVE or equivalent advisory identifier. The question explicitly covered the products’ full history, distinct from the preceding six-month reporting window. This is a maintainer attestation; no independent exhaustive advisory-history audit is claimed. The criterion allows N/A when there have been no publicly known product vulnerabilities; dependency vulnerabilities are outside this criterion.


 Reporting 8/8 ●

  • 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). (URL required) [report_process]

    The contributor guide directs contributors to raise issues for proposed changes; the public issue tracker accepts bug reports: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/CONTRIBUTING.md and https://github.com/Busnes-app/KyPulse-server/issues.



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    The project has a public GitHub issue tracker: https://github.com/Busnes-app/KyPulse-server/issues.



    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]

    Complete public GitHub issue history since 2025-10-25 contains 2 issues: 2 self-filed by the primary maintainer Yoshiofthewire, 0 automated tasks, and 0 reports/requests from external humans. Excluding maintainer self-tasks and automation per the official criterion autofill guidance, there are no qualifying external public reports requiring an acknowledgement/response in this window. Public tracker: https://github.com/Busnes-app/KyPulse-server/issues?q=is%3Aissue%20created%3A%3E%3D2025-10-25. This does not assert measured response performance or cover an undisclosed off-tracker intake channel. The primary developer confirms GitHub Issues is the only bug-report intake and all bug reports were acknowledged during the past 2–12 months. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]
    The response MAY be 'no' or a discussion about its merits. The goal is simply that there be some response to some requests, which indicates that the project is still alive. For purposes of this criterion, projects need not count fake requests (e.g., from spammers or automated systems). If a project is no longer making enhancements, please select "unmet" and include the URL that makes this situation clear to users. If a project tends to be overwhelmed by the number of enhancement requests, please select "unmet" and explain.

    Complete public GitHub issue history since 2025-10-25 contains 2 issues: 2 self-filed by the primary maintainer Yoshiofthewire, 0 automated tasks, and 0 reports/requests from external humans. Excluding maintainer self-tasks and automation per the official criterion autofill guidance, there are no qualifying external public reports requiring an acknowledgement/response in this window. Public tracker: https://github.com/Busnes-app/KyPulse-server/issues?q=is%3Aissue%20created%3A%3E%3D2025-10-25. This does not assert measured response performance or cover an undisclosed off-tracker intake channel. The primary developer confirms GitHub Issues is the only feature-request intake and all feature requests were acknowledged during the past 2–12 months. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    Public bug reports and responses are archived and searchable in GitHub issues: https://github.com/Busnes-app/KyPulse-server/issues. This does not attest to response rates.


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]
    Projects hosted on GitHub SHOULD consider enabling privately reporting a security vulnerability. Projects on GitLab SHOULD consider using its ability for privately reporting a vulnerability. Projects MAY identify a mailing address on https://PROJECTSITE/security, often in the form security@example.org. This vulnerability reporting process MAY be the same as its bug reporting process. Vulnerability reports MAY always be public, but many projects have a private vulnerability reporting mechanism.

    The public security policy explains where and how to report vulnerabilities for this repository: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/SECURITY.md. A promised response target is not evidence of actual response times.



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]
    Examples include a private defect report submitted on the web using HTTPS (TLS) or an email encrypted using OpenPGP. If vulnerability reports are always public (so there are never private vulnerability reports), choose "not applicable" (N/A).

    The public policy explains private reporting through GitHub Security Advisories: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/SECURITY.md. The maintainer-authenticated GitHub API independently reported private vulnerability reporting enabled for this repository during this task. Public policy evidence and authenticated configuration observation are distinct; no test vulnerability report was sent.



    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. [vulnerability_report_response]
    If there have been no vulnerabilities reported in the last 6 months, choose "not applicable" (N/A).

    The project owner confirmed on 2026-10-25 that no vulnerability reports were received in the previous six months. Therefore the response-time criterion is not applicable for this reporting period.


 Quality 12/13 ●

  • 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. [build]
    A build system determines what actions need to occur to rebuild the software (and in what order), and then performs those steps. For example, it can invoke a compiler to compile the source code. If an executable is created from source code, it must be possible to modify the project's source code and then generate an updated executable with those modifications. If the software produced by the project depends on external libraries, the build system does not need to build those external libraries. If there is no need to build anything to use the software after its source code is modified, select "not applicable" (N/A).

    The project provides a documented automated source build using its standard build system: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/Makefile. Source configuration inspected; no fresh build result is asserted.



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]
    For example, Maven, Ant, cmake, the autotools, make, rake (Ruby), or devtools (R).

    The documented source build uses common language/platform tools (Go/Make, Gradle, CMake or Xcode as applicable): https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/Makefile.



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    The documented supported source build uses FLOSS language/platform tools: Go and, where the embedded web frontend is rebuilt, Node/npm with its source build scripts. The build instructions and committed Ubuntu/Linux workflow define that source-build path: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/README.md ; https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/Makefile ; https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml. This is a source-supported build-path proposal; no exclusively-FLOSS-machine rebuild was run by this research step.


  • 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]
    The project MAY use multiple automated test suites (e.g., one that runs quickly, vs. another that is more thorough but requires special equipment). There are many test frameworks and test support systems available, including Selenium (web browser automation), Junit (JVM, Java), RUnit (R), testthat (R).

    The MIT-licensed repository contains automated tests (for example https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/cmd/kypulse-send/main_test.go) and publicly documents/invokes them in https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml. This is source inspection, not a fresh test-suite execution.



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]
    For example, "make check", "mvn test", or "rake test" (Ruby).

    The project uses its language/toolchain’s normal automated test command in https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml. This verifies the documented invocation, not an execution result.



    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]

    A committed GitHub Actions workflow invokes automated tests on changed code: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml. Workflow source was inspected; actual CI results were not fetched by this draft step.


  • 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]
    As long as a policy is in place, even by word of mouth, that says developers should add tests to the automated test suite for major new functionality, select "Met."

    The contributor guide explicitly requires tests or runnable checks with new non-trivial logic/behavior: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/CONTRIBUTING.md. This documents policy, not an audit of adherence.



    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]
    Major functionality would typically be mentioned in the release notes. Perfection is not required, merely evidence that tests are typically being added in practice to the automated test suite when new major functionality is added to the software produced by the project.

    Recent meaningful changes demonstrate the policy in practice: #43 “fix(auth): let local accounts enrol and remove TOTP” (https://github.com/Busnes-app/KyPulse-server/pull/43) changes implementation and adds/extends automated tests, e.g. https://github.com/Busnes-app/KyPulse-server/blob/883630eff11a80422cd2639ae375922ebbcad3f7/internal/api/mfa_enroll_test.go ; #36 “fix(bootstrap): write the generated admin password to a file, not the log” (https://github.com/Busnes-app/KyPulse-server/pull/36) changes implementation and adds/extends automated tests, e.g. https://github.com/Busnes-app/KyPulse-server/blob/24008d8c6019bcb4128e7d938679a06684db1812/cmd/server/bootstrap_test.go. Both implementation and positive test-code additions were checked in the merged PR diffs. This is evidence of recent typical adherence, not a claim that every diff adds tests or that coverage is complete.



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    The contributor guide explicitly requires tests or runnable checks with new non-trivial logic/behavior: https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/CONTRIBUTING.md. This documents policy, not an audit of adherence.


  • 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. [warnings]
    Examples of compiler warning flags include gcc/clang "-Wall". Examples of a "safe" language mode include JavaScript "use strict" and perl5's "use warnings". A separate "linter" tool is simply a tool that examines the source code to look for code quality errors or common simple mistakes. These are typically enabled within the source code or build instructions.

    The committed check workflow enables a code-quality checker/linter (go vet, ShellCheck or Android Lint as applicable): https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml. Addressing all emitted warnings is a separate unverified criterion.



    The project MUST address warnings. [warnings_fixed]
    These are the warnings identified by the implementation of the warnings criterion. The project should fix warnings or mark them in the source code as false positives. Ideally there would be no warnings, but a project MAY accept some warnings (typically less than 1 warning per 100 lines or less than 10 warnings).

    The project owner and primary developer (GitHub: Yoshiofthewire) confirmed on 2026-10-25 that valid compiler/linter warnings are fixed and false positives are documented in the relevant source or check configuration, with no repository exceptions. This records the maintainer's warning-handling practice, not an independent audit of every diagnostic log.



    It is SUGGESTED that projects 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 frontend explicitly enables TypeScript strict mode; CI also runs the Go vet/compiler diagnostic gates for the backend. These are concrete stricter checks rather than an unenforced style preference.

    Sources:
    https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/web/tsconfig.json
    https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml

    Scope: Practical strictness is evidenced, not a claim that every possible optional compiler or linter diagnostic is enabled.


 Security 16/16 ●

 Analysis 8/8 ●

  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]
    A static code analysis tool examines the software code (as source code, intermediate code, or executable) without executing it with specific inputs. For purposes of this criterion, compiler warnings and "safe" language modes do not count as static code analysis tools (these typically avoid deep analysis because speed is vital). Some static analysis tools focus on detecting generic defects, others focus on finding specific kinds of defects (such as vulnerabilities), and some do a combination. Examples of such static code analysis tools include cppcheck (C, C++), clang static analyzer (C, C++), SpotBugs (Java), FindBugs (Java) (including FindSecurityBugs), PMD (Java), Brakeman (Ruby on Rails), lintr (R), goodpractice (R), Coverity Quality Analyzer, SonarQube, Codacy, and HP Enterprise Fortify Static Code Analyzer. Larger lists of tools can be found in places such as the Wikipedia list of tools for static code analysis, OWASP information on static code analysis, NIST list of source code security analyzers, and Wheeler's list of static analysis tools. If there are no FLOSS static analysis tools available for the implementation language(s) used, you may select 'N/A'.

    The primary developer confirms static code analysis is run before production releases. Public GitHub Actions history is available at https://github.com/Busnes-app/KyPulse-server/actions. This is a maintainer attestation to the release practice, distinct from inspection of an individual CI run. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [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’s vulnerability-query analysis actually completed successfully for inspected commit 56aab1c9930bbff753002e5c177fe46660cd658e, not merely a configured workflow. Run: https://github.com/Busnes-app/KyPulse-server/actions/runs/40199073942; successful analysis step: https://github.com/Busnes-app/KyPulse-server/actions/runs/40199073942/job/121186159672. CodeQL publishes its security query descriptions at https://codeql.github.com/codeql-query-help/. This does not establish pre-release analysis coverage or remediation of findings.



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]
    A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known. Note that criterion vulnerabilities_fixed_60_days requires that all such vulnerabilities be fixed within 60 days of being made public.

    The primary developer confirms confirmed medium-or-higher security findings from static analysis are fixed before production releases. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    Static vulnerability analysis is configured on pushes and pull requests, rather than only at release time.

    Sources:
    https://github.com/Busnes-app/KyPulse-server/actions/runs/40199074019
    https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/.github/workflows/ci.yml

    Scope: Observed successful runs, when linked, are prior CI executions. Workflow configuration establishes triggers; it is not a claim that every historical run succeeded.


  • 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]
    A dynamic analysis tool examines the software by executing it with specific inputs. For example, the project MAY use a fuzzing tool (e.g., American Fuzzy Lop) or a web application scanner (e.g., OWASP ZAP or w3af). In some cases the OSS-Fuzz project may be willing to apply fuzz testing to your project. For purposes of this criterion the dynamic analysis tool needs to vary the inputs in some way to look for various kinds of problems or be an automated test suite with at least 80% branch coverage. The Wikipedia page on dynamic analysis and the OWASP page on fuzzing identify some dynamic analysis tools. The analysis tool(s) MAY be focused on looking for security vulnerabilities, but this is not required.

    The primary developer confirms dynamic analysis is run before production releases. Public GitHub Actions history is available at https://github.com/Busnes-app/KyPulse-server/actions. This records the maintainer’s release practice; it is not a claim that every historical run was independently audited. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



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

    The project-owned source in the inspected snapshot is written in memory-safe languages/scripts; no project-produced C/C++ source was found. Linked third-party/runtime implementations are not represented as project-authored unsafe code.

    Sources:
    https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/README.md

    Scope: This is a source-language applicability decision, not a memory-safety audit or a claim that unsafe/FFI APIs cannot be misused.



    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]
    This criterion does not suggest enabling assertions during production; that is entirely up to the project and its users to decide. This criterion's focus is instead to improve fault detection during dynamic analysis before deployment. Enabling assertions in production use is completely different from enabling assertions during dynamic analysis (such as testing). In some cases enabling assertions in production use is extremely unwise (especially in high-integrity components). There are many arguments against enabling assertions in production, e.g., libraries should not crash callers, their presence may cause rejection by app stores, and/or activating an assertion in production may expose private data such as private keys. Beware that in many Linux distributions NDEBUG is not defined, so C/C++ assert() will by default be enabled for production in those environments. It may be important to use a different assertion mechanism or defining NDEBUG for production in those environments.

    Test code includes many explicit active assertion/failure checks: 108 in the inspected sample https://github.com/Busnes-app/KyPulse-server/blob/56aab1c9930bbff753002e5c177fe46660cd658e/internal/api/api_test.go. The corresponding test configuration actually ran successfully for commit 56aab1c9930bbff753002e5c177fe46660cd658e: https://github.com/Busnes-app/KyPulse-server/actions/runs/40199074019/job/121186157453, step “Run go test -fuzz=FuzzDecode -fuzztime=100000x ./internal/ingest”. Go t.Fatal/Error, JUnit assertions or Node assert checks in these tests are not removed by production NDEBUG settings. This establishes assertions in test configuration, not80%branch coverage or analysis before every release. The primary developer confirms assertions remain enabled during dynamic analysis before production releases. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]
    If you are not running dynamic code analysis and thus have not found any vulnerabilities in this way, choose "not applicable" (N/A). A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known.

    The primary developer confirms confirmed medium-or-higher security findings from dynamic analysis are fixed before production releases. Attested directly by the project owner and primary developer (GitHub: Yoshiofthewire) on 2026-10-25.



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/15931/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 Yoshiofthewire and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Yoshiofthewire.
Entry created on 2026-10-26 00:18:50 UTC, last updated on 2026-10-26 11:09:03 UTC.