Macro-Deck

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

    The open-source macro pad with customizable widgets, powerful integrations and a secure plugin ecosystem.

    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.

 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.

    GitHub requires 2FA as of March 2023.


    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.

    Macro Deck uses GitHub for version control. New collaborators must be explicitly granted access to the repository, with permissions assigned according to their responsibilities. GitHub's role-based access control ensures that collaborators only receive the permissions assigned to them.


    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.

    The project's primary branch is protected using GitHub repository rulesets. Direct commits are blocked, and changes must be submitted through pull requests before they can be merged.


    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.

    The project's primary branch is protected using GitHub repository rulesets. Branch deletion is restricted to prevent accidental or unauthorized removal of the primary branch.


    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.

    Macro Deck uses GitHub Actions for CI/CD. Untrusted inputs, such as pull request metadata, branch names, and user-provided parameters, are handled through GitHub Actions contexts and environment variables rather than being directly interpolated into executable shell commands. Inputs are validated where necessary to prevent command injection and unintended workflow execution.


    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.

    Macro Deck uses GitHub Actions for CI/CD. Workflows triggered by pull requests from forks run with restricted permissions and do not receive repository secrets. Privileged credentials, such as signing certificates, publishing tokens, and deployment secrets, are reserved for trusted release workflows and are not exposed to untrusted code.


    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.

    All official Macro Deck project channels, including the website, documentation, GitHub repositories, community platforms, and the Macro Deck Store, are accessible via HTTPS. Encrypted connections are used to protect communication with these services.


    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.

    All official Macro Deck distribution channels, including GitHub Releases and the official website, use HTTPS to ensure encrypted and authenticated connections and protect against adversary-in-the-middle attacks. Additionally, the Macro Deck installers are digitally signed using code signing certificates, providing an additional layer of authenticity and integrity verification.


    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.

    Macro Deck uses GitHub Actions secrets to securely store sensitive credentials, such as signing certificates, API tokens, and publishing credentials, outside the version control system. Sensitive configuration files are excluded from version control where applicable. Repository secret scanning is used to help detect accidentally committed credentials.


    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.

    Macro Deck provides publicly accessible user documentation at https://docs.macro-deck.app/, covering installation, initial setup, configuration, and the basic functionality of the application. The documentation is maintained alongside the project to help users get started and use Macro Deck's core features.


    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.

    Macro Deck uses GitHub Issues for defect reporting. Users can report bugs through the project's GitHub repository at https://github.com/Macro-Deck-App/Macro-Deck/issues/new/choose. Dedicated issue templates guide users through providing relevant information, including a description of the problem, steps to reproduce it, expected behavior, and environment details.


    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.

    Macro Deck provides multiple public channels for discussing proposed changes, feature requests, and usage difficulties. GitHub Issues and Pull Requests allow users and contributors to propose features, report problems, and discuss implementation details. Additionally, the official Macro Deck Discord community provides dedicated channels for support, feedback, feature suggestions, and general discussions.


    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.

    Macro Deck accepts public contributions through GitHub. The project's contribution guidelines describe how contributors can report issues, propose changes, and submit pull requests. GitHub Issues and Pull Requests are used to coordinate contributions and review proposed changes before merging.


    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 Apache-2.0 license for the repository contents is approved by the Open Source Initiative (OSI).


    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.

    The Apache-2.0 license is approved by the Open Source Initiative (OSI). [floss_license]


    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.

    Macro Deck's source code license is maintained in the LICENSE file at the root of the GitHub repository, making the licensing terms publicly accessible to users and contributors.

    https://github.com/Macro-Deck-App/Macro-Deck/blob/main/LICENSE


    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.

    Macro Deck's source code releases include the project's LICENSE file in the repository root. The license is included in the source archives provided through GitHub Releases, ensuring that the applicable licensing terms are available alongside the released source code.

    https://github.com/Macro-Deck-App/Macro-Deck/releases


    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.

    Macro Deck's source code is publicly accessible without authentication through its official GitHub repository at https://github.com/Macro-Deck-App/Macro-Deck. The repository provides a permanent URL where anyone can browse, clone, and review the project's source code.


    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.

    Macro Deck uses Git and GitHub for version control. The repository maintains a publicly accessible commit history that records code changes, their authors, and timestamps. Each commit includes a unique identifier and can be inspected through GitHub, providing traceability of changes to the project's source code.

    https://github.com/Macro-Deck-App/Macro-Deck/commits/main/


    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.

    Macro Deck maintains its direct dependencies in version-controlled package manifests across its technology stack. .NET dependencies are declared using NuGet PackageReference entries in C# project files, with versions centrally managed through Directory.Packages.props. JavaScript and Angular dependencies are declared in package.json files, with package-lock.json providing reproducible dependency resolution. The Tauri-based desktop bootstrapper uses Rust's Cargo dependency management. These dependency manifests are maintained alongside the source code in the public GitHub repository.


    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.

    Macro Deck maintains a publicly accessible list of its project repositories in the official GitHub organization profile README. The documentation provides direct links and descriptions of the repositories and their purposes.

    https://github.com/Macro-Deck-App/.github/blob/main/profile/README.md#repositories


    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.

    Macro Deck does not store generated executable artifacts in its source code repository. Compiled binaries, installers, and other build outputs are generated through the CI/CD pipeline and distributed separately via GitHub Releases. Build output directories are excluded from version control using .gitignore rules.


    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.

    Macro Deck keeps its source code and build configurations in human-readable formats. Compiled binaries and other non-reviewable build artifacts are distributed separately through GitHub Releases rather than being committed to the source repository. Binary assets required by the project, such as images and icons, are limited to resources necessary for the application's functionality.


    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.

    Macro Deck provides security contact information through its GitHub repository's security policy. Security vulnerabilities can be reported privately using GitHub's vulnerability reporting feature, allowing security issues to be disclosed without publicly exposing sensitive details.

    https://github.com/Macro-Deck-App/Macro-Deck/security/policy



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

Project badge entry owned by: Manuel Mayer.
Entry created on 2026-10-09 09:58:51 UTC, last updated on 2026-10-09 10:11:23 UTC.