.github

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


These are the Baseline Level 2 criteria. These are criteria version v2026.02.19.

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

        

 Basics

  • General

    Note that other projects may use the same name.

    Shared workflows, community health files and org profile for Monumental Archive

    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 19/19 ●

  • Controls


    Enough for a badge!

    When a CI/CD task is executed with no permissions specified, the CI/CD system MUST default the task's permissions to the lowest permissions granted in the pipeline. [OSPS-AC-04.01]
    Configure the project's settings to assign the lowest available permissions to new pipelines by default, granting additional permissions only when necessary for specific tasks.

    Least privilege is the default and the explicit setting: the repository baseline sets the workflow token to read-only permissions, and every workflow declares its own minimal permissions: block on top of that. A job that specifies nothing therefore gets read, not write. https://github.com/monumental-archive/.github/tree/main/settings


    Enough for a badge!

    When an official release is created, that release MUST be assigned a unique version identifier. [OSPS-BR-02.01]
    Assign a unique version identifier to each release produced by the project, following a consistent naming convention or numbering scheme. Examples include SemVer, CalVer, or git commit id.

    Every release is a unique semantic version, derived from conventional commits by git-cliff and tagged v<major>.<minor>.<patch> by the release App; the tag ruleset makes tags immutable, so a version identifier is never reused.


    Enough for a badge!

    When an official release is created, that release MUST contain a descriptive log of functional and security modifications. [OSPS-BR-04.01]
    Ensure that all releases include a descriptive change log. It is recommended to ensure that the change log is human-readable and includes details beyond commit messages, such as descriptions of the security impact or relevance to different use cases. To ensure machine readability, place the content under a markdown header such as "## Changelog".

    CHANGELOG.md is generated by git-cliff from conventional commits and the same descriptive log is attached to each GitHub release, so functional and security modifications are recorded per release. https://github.com/monumental-archive/.github/releases


    Enough for a badge!

    When a build and release pipeline ingests dependencies, it MUST use standardized tooling where available. [OSPS-BR-05.01]
    Use a common tooling for your ecosystem, such as package managers or dependency management tools to ingest dependencies at build time. This may include using a dependency file, lock file, or manifest to specify the required dependencies, which are then pulled in by the build system.

    Dependency ingestion is standardised: mise with an exact-version config and a lockfile carrying per-platform checksums for tools, and the language-native managers (cargo, npm) for consuming repositories. Preference is for aqua-backed tools so downloads carry checksums and attestations rather than running install scripts.


    Enough for a badge!

    When an official release is created, that release MUST be signed or accounted for in a signed manifest including each asset's cryptographic hashes. [OSPS-BR-06.01]
    Sign all released software assets at build time with a cryptographic signature or attestations, such as GPG or PGP signature, Sigstore signatures, SLSA provenance, or SLSA VSAs. Include the cryptographic hashes of each asset in a signed manifest or metadata file.

    Each release carries a Sigstore evidence bundle and GitHub artifact attestations covering every published asset by cryptographic digest, and docs/runbook.md documents how a consumer verifies them. https://github.com/monumental-archive/.github/blob/main/docs/runbook.md


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a description of how the project selects, obtains, and tracks its dependencies. [OSPS-DO-06.01]
    It is recommended to publish this information alongside the project's technical & design documentation on a publicly viewable resource such as the source code repository, project website, or other channel.

    Documented in two places and deliberately so: docs/tooling-verdicts.md records how a dependency is selected — the priors a tool must meet to enter the belt, and the verdicts on tools considered and declined — and docs/dependency-track.md records how dependencies are obtained, pinned, monitored and triaged. https://github.com/monumental-archive/.github/blob/main/docs/tooling-verdicts.md


    Enough for a badge!

    The project documentation MUST include instructions on how to build the software, including required libraries, frameworks, SDKs, and dependencies. [OSPS-DO-07.01]
    It is recommended to publish this information alongside the project's contributor documentation, such as in CONTRIBUTING.md or other developer task documentation. This may also be documented using Makefile targets or other automation scripts.

    README.md and CONTRIBUTING.md give the whole sequence: mise trust && mise install brings every required tool at its pinned version from the lockfile, and mise run ci then runs exactly what CI runs. There are no separate libraries, frameworks or SDKs to install. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md


    Enough for a badge!

    While active, the project documentation MUST include a list of project members with access to sensitive resources. [OSPS-GV-01.01]
    Document project participants and their roles through such artifacts as members.md, governance.md, maintainers.md, or similar file within the source code repository of the project. This may be as simple as including names or account handles in a list of maintainers, or more complex depending on the project's governance.

    docs/continuity.md carries an asset table naming who holds each sensitive resource — organisation ownership, the tag-mint App key, registry accounts, the one standing token — and what happens to each if that person is unavailable. https://github.com/monumental-archive/.github/blob/main/docs/continuity.md


    Enough for a badge!

    While active, the project documentation MUST include descriptions of the roles and responsibilities for members of the project. [OSPS-GV-01.02]
    Document project participants and their roles through such artifacts as members.md, governance.md, maintainers.md, or similar file within the source code repository of the project.

    GOVERNANCE.md carries a 'Roles and responsibilities' table naming three roles - maintainer/owner, contributor, automation - and the responsibilities of each, and it is served from the organisation's .github repository as a default community health file so it applies to every repository that does not carry its own. Who holds the maintainer role is explicit: the @monumental-archive/owners team, which CODEOWNERS routes every review to. https://github.com/monumental-archive/.github/blob/main/GOVERNANCE.md#roles-and-responsibilities


    Enough for a badge!

    While active, the project documentation MUST include a guide for code contributors that includes requirements for acceptable contributions. [OSPS-GV-03.02]
    Extend the CONTRIBUTING.md or CONTRIBUTING/ contents in the project documentation to outline the requirements for acceptable contributions, including coding standards, testing requirements, and submission guidelines for code contributors. It is recommended that this guide is the source of truth for both contributors and approvers.

    CONTRIBUTING.md includes a 'Requirements for acceptable contributions' section: pull request only, a green mise run ci, Conventional Commits with imperative lowercase subjects under 72 columns, DCO sign-off, squash merge. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md


    Enough for a badge!

    While active, the version control system MUST require all code contributors to assert that they are legally authorized to make the associated contributions on every commit. [OSPS-LE-01.01]
    Include a DCO in the project's repository, requiring code contributors to assert that they are legally authorized to commit the associated contributions on every commit. Use a status check to ensure the assertion is made. A CLA also satisfies this requirement. Some version control systems, such as GitHub, may include this in the platform terms of service.

    Every commit must carry a Developer Certificate of Origin 1.1 sign-off asserting legal authorisation. The commit-msg hook catches a missing trailer locally and lint:dco fails the gate, with no exemption list — automation signs off too.


    Enough for a badge!

    When a commit is made to the primary branch, any automated status checks for commits MUST pass or be manually bypassed. [OSPS-QA-03.01]
    Configure the project's version control system to require that all automated status checks pass or require manual acknowledgement before a commit can be merged into the primary branch. It is recommended that any optional status checks are NOT configured as a pass or fail requirement that approvers may be tempted to bypass.

    The gate is a required status check on main under an organisation ruleset: a pull request cannot merge red, and direct pushes are blocked entirely, so no commit reaches the primary branch without its checks passing. https://github.com/monumental-archive/.github/blob/main/docs/rulesets.md


    Enough for a badge!

    Prior to a commit being accepted, the project's CI/CD pipelines MUST run at least one automated test suite to ensure the changes meet expectations. [OSPS-QA-06.01]
    Automated tests should be run prior to every merge into the primary branch. The test suite should be run in a CI/CD pipeline and the results should be visible to all contributors. The test suite should be run in a consistent environment and should be run in a way that allows contributors to run the tests locally. Examples of test suites include unit tests, integration tests, and end-to-end tests.

    gate.yml runs the full automated suite — mise run ci, every belt check against every tracked file — on each pull request before it can be accepted, and it does so by self-applying the reusable workflow this project publishes. https://github.com/monumental-archive/.github/blob/main/.github/workflows/gate.yml


    Enough for a badge!

    When the project has made a release, the project documentation MUST include design documentation demonstrating all actions and actors within the system. [OSPS-SA-01.01]
    Include designs in the project documentation that explains the actions and actors. Actors include any subsystem or entity that can influence another segment in the system. Ensure this is updated for new features or breaking changes.

    docs/release.md specifies the pipeline actor by actor and action by action — what each workflow does, which identity it runs as, what it is permitted to touch — and docs/build-track.md and docs/source-track.md carry the per-track designs. The capability boundary between caller code and the privileged identity is stated explicitly as a design rule. https://github.com/monumental-archive/.github/blob/main/docs/release.md


    Enough for a badge!

    When the project has made a release, the project documentation MUST include descriptions of all external software interfaces of the released software assets. [OSPS-SA-02.01]
    Document all software interfaces (APIs) of the released software assets, explaining how users can interact with the software and what data is expected or produced. Ensure this is updated for new features or breaking changes.

    The external interfaces are the reusable workflows and the task contract: docs/runbook.md documents each workflow's inputs and the artifact classes with their required parameters, and workflow-templates/ ships a caller stub per workflow. https://github.com/monumental-archive/.github/blob/main/docs/runbook.md


    Enough for a badge!

    When the project has made a release, the project MUST perform a security assessment to understand the most likely and impactful potential security problems that could occur within the software. [OSPS-SA-03.01]
    Performing a security assessment informs both project members as well as downstream consumers that the project understands what problems could arise within the software. Understanding what threats could be realized helps the project manage and address risk. This information is useful to downstream consumers to demonstrate the security acumen and practices of the project. Ensure this is updated for new features or breaking changes.

    docs/build-assessment.md and docs/source-assessment.md are written security assessments of this system: they walk the controls, name the most likely and impactful failure modes (untrusted caller code reaching a privileged signing identity, supply-chain substitution through unpinned dependencies, silent settings drift), and record which are mitigated and which are accepted. https://github.com/monumental-archive/.github/blob/main/docs/build-assessment.md


    Enough for a badge!

    While active, the project documentation MUST include a policy for coordinated vulnerability disclosure (CVD), with a clear timeframe for response. [OSPS-VM-01.01]
    Create a SECURITY.md file at the root of the directory, outlining the project's policy for coordinated vulnerability disclosure. Include a method for reporting vulnerabilities. Set expectations for how the project will respond and address reported issues.

    SECURITY.md is the coordinated disclosure policy and it states the timeframe: private reporting through the repository's Security tab, acknowledgement within 14 days, and what the reporter can expect afterwards. https://github.com/monumental-archive/.github/blob/main/SECURITY.md


    Enough for a badge!

    While active, the project documentation MUST provide a means for private vulnerability reporting directly to the security contacts within the project. [OSPS-VM-03.01]
    Provide a means for security researchers to report vulnerabilities privately to the project. This may be a dedicated email address, a web form, VCS specialized tools, email addresses for security contacts, or other methods.

    GitHub private vulnerability reporting is enabled and is the documented channel in SECURITY.md, delivering the report directly to the security contact without public exposure. https://github.com/monumental-archive/.github/blob/main/SECURITY.md


    Enough for a badge!

    While active, the project documentation MUST publicly publish data about discovered vulnerabilities. [OSPS-VM-04.01]
    Provide information about known vulnerabilities in a predictable public channel, such as a CVE entry, blog post, or other medium. To the degree possible, this information should include affected version(s), how a consumer can determine if they are vulnerable, and instructions for mitigation or remediation.

    Vulnerability data is published rather than held privately: resolved reports would be published as GitHub Security Advisories on the repository, and the dependency track already publishes machine-readable VEX decisions keyed by package and version for the advisories that touch this project's dependencies. No vulnerability in this project's own code has been discovered to date. https://github.com/monumental-archive/.github/blob/main/docs/dependency-track.md



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 Carl Allen and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Carl Allen.
Entry created on 2026-08-13 07:47:41 UTC, last updated on 2026-08-13 19:08:33 UTC. Last achieved passing badge on 2026-08-13 08:01:08 UTC.