Kouxian Digital Rhythm (扣舷-数字节律)

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 baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 16517 is baseline-1 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/16517/baseline)](https://www.bestpractices.dev/projects/16517)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/16517"><img src="https://www.bestpractices.dev/projects/16517/baseline"></a>


These are the Baseline Level 1 criteria. These are criteria version v2026.08.28.

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

        

 Basics

  • General

    Note that other projects may use the same name.

    A local-first Windows desktop application for reviewing digital-activity rhythms. Public scope covers source code, tests, and documentation only; no Windows installer is distributed.

    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.

    Scope: https://github.com/Ansel-Poiesis/interaction-rhythm-source (main; initial tag v0.1.0). This is the sole public codebase. The private development workspace is not part of the public project. The legacy distribution repository retains historical release notes/tags only; v0.11.3, v0.11.6, and v0.11.8 EXE/ZIP assets have been withdrawn. Current source releases contain no installer binaries. Third-party fonts and components retain their own licenses as listed in THIRD_PARTY_NOTICES.md.

 Controls 24/24 ●

  • Controls


    Enough for a badge!

    When a user attempts to read or modify a sensitive resource in the project's authoritative repository, the system MUST require the user to complete a multi-factor authentication process. [OSPS-AC-01.01]
    Enforce multi-factor authentication for the project's version control system, requiring collaborators to provide a second form of authentication when accessing sensitive data or modifying repository settings. Passkeys are acceptable for this control.

    The only account with access to sensitive repository resources is the maintainer, whose GitHub account has two-factor authentication enabled. The collaborator list contains no other users.


    Enough for a badge!

    When a new collaborator is added, the version control system MUST require manual permission assignment, or restrict the collaborator permissions to the lowest available privileges by default. [OSPS-AC-02.01]
    Most public version control systems are configured in this manner. Ensure the project's version control system always assigns the lowest available permissions to collaborators by default when added, granting additional permissions only when necessary.

    Collaborators are added only through an individual invitation by the repository owner. This personal-account repository offers only owner/collaborator roles; collaborator access is the lowest available role. The current access list contains only the owner. See https://docs.github.com/en/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/repository-access-and-collaboration/permission-levels-for-a-personal-account-repository.


    Enough for a badge!

    When a direct commit is attempted on the project's primary branch, an enforcement mechanism MUST prevent the change from being applied. [OSPS-AC-03.01]
    If the VCS is centralized, set branch protection on the primary branch in the project's VCS. Alternatively, use a decentralized approach, like the Linux kernel's, where changes are first proposed in another repository, and merging changes into the primary repository requires a specific separate act.

    GitHub branch protection on main requires a pull request and the successful windows-python check, applies to administrators, and blocks force pushes. Direct pushes are prevented.


    Enough for a badge!

    When an attempt is made to delete the project's primary branch, the version control system MUST treat this as a sensitive activity and require explicit confirmation of intent. [OSPS-AC-03.02]
    Set branch protection on the primary branch in the project's version control system to prevent deletion.

    GitHub main-branch protection has allow_deletions=false. Deletion of the primary branch is blocked.


    Enough for a badge!

    When a CI/CD pipeline operates on untrusted metadata, those parameters MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.01]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all metadata inputs which correspond to untrusted sources. This includes data such as branch names, commit messages, tags, pull request titles, and author information.

    The CI workflow does not interpolate untrusted event metadata into shell commands. Its steps run fixed commands, and workflow_dispatch defines no user-controlled inputs. See https://github.com/Ansel-Poiesis/interaction-rhythm-source/blob/main/.github/workflows/ci.yml.


    Enough for a badge!

    When a CI/CD pipeline operates on untrusted code snapshots, it MUST prevent access to privileged CI/CD credentials and assets. [OSPS-BR-01.03]
    CI/CD pipelines should isolate untrusted code snapshots from privileged credentials and assets. In particular, projects should be careful to ensure that workflows which build or execute code prior to review by a collaborator do not have access to CI/CD credentials.

    The workflow grants only contents:read, contains no repository-secret references, and no repository secrets are configured. Pull-request jobs therefore have no repository write token or privileged project secrets.


    Enough for a badge!

    When the project lists a URI as an official project channel, that URI MUST be exclusively delivered using encrypted channels. [OSPS-BR-03.01]
    Configure the project's websites and version control systems to use encrypted channels such as SSH or HTTPS for data transmission. Ensure all tools and domains referenced in project documentation can only be accessed via encrypted channels.

    Official project and source-repository URLs use HTTPS. The http:// URLs in source code are limited to loopback application endpoints; the OFL URL is an upstream license reference, not a project channel.


    Enough for a badge!

    When the project lists a URI as an official distribution channel, that channel MUST be protected from adversary-in-the-middle attacks using cryptographically authenticated channels. [OSPS-BR-03.02]
    Artifacts distributed by the project should be distributed through channels which ensure integrity and authenticity. Use of HTTPS for downloads, signed releases, or distribution through trusted package managers are all acceptable methods to protect against adversary-in-the-middle attacks.

    The only current public software distribution channel is the GitHub source repository and its source archives, delivered over HTTPS. No installer binaries are distributed; the previous v0.11.3, v0.11.6, and v0.11.8 EXE/ZIP assets were withdrawn.


    Enough for a badge!

    The project MUST prevent the unintentional storage of unencrypted sensitive data, such as secrets and credentials, in the version control system. [OSPS-BR-07.01]
    Configure .gitignore or equivalent to exclude files that may contain sensitive information. Use pre-commit hooks and automated scanning tools to detect and prevent the inclusion of sensitive data in commits.

    GitHub secret scanning and push protection are enabled. The clean public tree excludes local databases, settings, logs, temporary data, certificates, and build output. Pre-release source review found no credential files.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include user guides for all basic functionality. [OSPS-DO-01.01]
    Create user guides or documentation for all basic functionality of the project, explaining how to install, configure, and use the project's features. If there are any known dangerous or destructive actions available, include highly-visible warnings.

    docs/user-guide.md covers startup, tray behavior, dashboard and heatmap, export, optional AI and email, backup, privacy controls, and exit.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a guide for reporting defects. [OSPS-DO-02.01]
    It is recommended that projects use their VCS default issue tracker. If an external source is used, ensure that the project documentation and contributing guide clearly and visibly explain how to use the reporting system. It is recommended that project documentation also sets expectations for how defects will be triaged and resolved.

    docs/bug-reporting.md and the public bug issue template explain how to report defects while excluding databases, logs, exports, screenshots, email addresses, and credentials.


    Enough for a badge!

    The project MUST have one or more mechanisms for public discussions about proposed changes and usage obstacles. [OSPS-GV-02.01]
    Establish one or more mechanisms for public discussions within the project, such as mailing lists, instant messaging, or issue trackers, to facilitate open communication and feedback.

    Public GitHub Issues support usage-obstacle discussion and pull requests support proposed changes: https://github.com/Ansel-Poiesis/interaction-rhythm-source/issues.


    Enough for a badge!

    The project documentation MUST include an explanation of the contribution process, or clearly state that public contributions are not accepted [OSPS-GV-03.01]
    Create a CONTRIBUTING.md or CONTRIBUTING/ directory to outline the contribution process including the steps for submitting changes, and engaging with the project maintainers.

    CONTRIBUTING.md explains the pull-request process, required checks, use of synthetic fixtures, exclusion of personal data, and disclosure of third-party material sources and licenses.


    Enough for a badge!

    The license for the source code MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.01]
    Add a LICENSE file to the project's repo with a license that is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Releasing to the public domain meets this control if there are no other encumbrances such as patents.

    The public source code is licensed under the OSI-approved MIT License in the repository root.


    Enough for a badge!

    The license for the released software assets MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.02]
    If a different license is included with released software assets, ensure it is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Note that the license for the released software assets may be different than the source code.

    Current public software releases contain MIT-licensed source only and no installer binaries. The legacy release repository has had its v0.11.3, v0.11.6, and v0.11.8 EXE/ZIP assets withdrawn and is documented as a historical record outside the current project distribution scope.


    Enough for a badge!

    The license for the source code MUST be maintained in the corresponding repository's LICENSE file, COPYING file, LICENSES/ directory, or LICENSE/ directory. [OSPS-LE-03.01]
    Include the project's source code license in the project's LICENSE file, COPYING file, LICENSES/ directory, or LICENSE/ directory to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    The root LICENSE file maintains the MIT license for the source code.


    Enough for a badge!

    The license for the released software assets MUST be included in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets. [OSPS-LE-03.02]
    Include the project's released software assets license in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    The v0.1.0 source tag includes the root MIT LICENSE file; GitHub source archives are generated from that licensed tree. No application binary is attached to the release.


    Enough for a badge!

    The project's source code repository MUST be publicly readable at a static URL. [OSPS-QA-01.01]
    Use a common VCS such as GitHub, GitLab, or Bitbucket. Ensure the repository is publicly readable. Avoid duplication or mirroring of repositories unless highly visible documentation clarifies the primary source. Avoid frequent changes to the repository that would impact the repository URL. Ensure the repository is public.

    The source repository is publicly readable at the static URL https://github.com/Ansel-Poiesis/interaction-rhythm-source.


    Enough for a badge!

    The version control system MUST contain a publicly readable record of all changes made, who made the changes, and when the changes were made. [OSPS-QA-01.02]
    Use a common VCS such as GitHub, GitLab, or Bitbucket to maintain a publicly readable commit history. Avoid squashing or rewriting commits in a way that would obscure the author of any commits.

    The public Git history records the clean root snapshot and the later documentation change, including authors and timestamps; the private development history was not imported.


    Enough for a badge!

    When the package management system supports it, the source code repository MUST contain a dependency list that accounts for the direct language dependencies. [OSPS-QA-02.01]
    This may take the form of a package manager or language dependency file that enumerates all direct dependencies such as package.json, Gemfile, or go.mod.

    Direct Python dependencies are listed in requirements.txt and requirements-dev.txt. JavaScript and PowerShell checks use runtime tools and introduce no additional package dependencies.


    Enough for a badge!

    Projects with multiple repositories MUST document a list of codebases that are part of the project. [OSPS-QA-04.01]
    Document any additional subproject code repositories produced by the project and compiled into a release. This documentation should include the status and intent of the respective codebase.

    docs/project-scope.md identifies interaction-rhythm-source as the sole current public codebase and documents the private development repository and legacy distribution repository as outside that codebase.


    Enough for a badge!

    The version control system MUST NOT contain generated executable artifacts. [OSPS-QA-05.01]
    Remove generated executable artifacts in the project's version control system. It is recommended that any scenario where a generated executable artifact appears critical to a process such as testing, it should be instead be generated at build time or stored separately and fetched during a specific well-documented pipeline step.

    The tracked public source tree contains no generated executables, installers, archives, shared libraries, or bytecode caches; git ls-files extension review returned zero matches.


    Enough for a badge!

    The version control system MUST NOT contain unreviewable binary artifacts. [OSPS-QA-05.02]
    Do not add any unreviewable binary artifacts to the project's version control system. This includes executable application binaries, library files, and similar artifacts. It does not include assets such as graphical images, sound or music files, and similar content typically stored in a binary format.

    Tracked binary files are reviewable product-content assets: PNG icons and OFL-licensed WOFF2 fonts with upstream notices. The repository contains no executable application binaries or compiled library files.


    Enough for a badge!

    The project documentation MUST contain security contacts. [OSPS-VM-02.01]
    Create a security.md (or similarly-named) file that contains security contacts for the project.

    SECURITY.md identifies the repository maintainer as the security contact through GitHub's private vulnerability reporting form and tells reporters not to post exploitable details publicly.



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

Project badge entry owned by: Ansel.
Entry created on 2026-11-10 06:03:55 UTC, last updated on 2026-11-10 06:21:53 UTC.