PR Metrics

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


These are the Baseline Level 1 criteria. These criteria are from baseline version v2025.10.10 with updated criteria text from version v2026.02.19. Criteria that are new in version v2026.02.19 are labeled "future" and will begin to be enforced starting 2026-06-01. Please provide answers to the "future" criteria before that date.

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

        

 Basics

  • General

    Note that other projects may use the same name.

    A GitHub Action & Azure Pipelines task for augmenting pull request titles to let reviewers quickly determine PR size and test coverage.

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

  • 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 has required two-factor authentication for all contributors since March 2023. The Microsoft GitHub organisation enforces additional authentication policies. See GitHub's 2FA requirement announcement: https://github.blog/news-insights/product-news/raising-the-bar-for-software-security-github-2fa-begins-march-13/.


    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.

    GitHub assigns read-only access by default to new collaborators on public repositories. The Microsoft GitHub organisation enforces least-privilege policies for collaborator access. Additional permissions require manual assignment by repository administrators.


    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 repository has multiple rulesets protecting the main branch (default-ruleset, microsoft-production-ruleset), which prevent direct commits and require pull request reviews. See repository rulesets: https://github.com/microsoft/PR-Metrics/rules.


    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 GitHub rulesets protecting the main branch prevent branch deletion. GitHub treats branch deletion of protected branches as a sensitive activity requiring explicit administrator override. See repository rulesets: https://github.com/microsoft/PR-Metrics/rules.


    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 project's CI/CD workflows (build.yml, release-initiate.yml, release-publish.yml) do not define any user-controllable input parameters via workflow_dispatch inputs. All workflow triggers use event-based activation with no externally supplied parameters.


    Unknown required information, not enough for a badge.

    (Future criterion) 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.

    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 URIs referenced in project documentation, README, and configuration files use HTTPS exclusively. The project's GitHub repository URL is https://github.com/microsoft/PR-Metrics. All external links (e.g., aka.ms redirects, Microsoft documentation) use HTTPS.


    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 release pipeline fetches all dependencies and tools via HTTPS (npm registry, GitHub API, GitHub Actions). Release artefacts are published via GitHub Releases and the Visual Studio Marketplace, both of which use HTTPS exclusively. Artefacts include build provenance attestations (https://github.com/microsoft/PR-Metrics/blob/main/docs/verification.md) and Sigstore cosign signatures.


    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.

    The .gitignore file excludes environment files (.env, .env.local, .env.*.local). The CI/CD pipeline includes gitleaks (https://github.com/microsoft/PR-Metrics/blob/main/.github/linters/gitleaks.toml) secret scanning via Super-Linter. No credentials or secrets are tracked in the repository. Access tokens are managed exclusively through GitHub Secrets.


    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.

    The README.md (https://github.com/microsoft/PR-Metrics/blob/main/README.md) provides comprehensive documentation covering installation, configuration inputs, usage examples for both GitHub Actions and Azure DevOps Pipelines, and detailed descriptions of all parameters. Additional documentation is available in the docs/ folder (https://github.com/microsoft/PR-Metrics/tree/main/docs), including troubleshooting and platform-specific guides.


    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.

    The project uses GitHub Issues with structured templates for bug reports (https://github.com/microsoft/PR-Metrics/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) and feature requests (https://github.com/microsoft/PR-Metrics/blob/main/.github/ISSUE_TEMPLATE/feature-request.md). The CONTRIBUTING.md (https://github.com/microsoft/PR-Metrics/blob/main/.github/CONTRIBUTING.md) directs contributors to use GitHub Issues for reporting defects and communicating with the team.


    Enough for a badge!

    While active, 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.

    The project provides multiple public discussion channels: GitHub Issues (https://github.com/microsoft/PR-Metrics/issues) for bug reports and feature requests, GitHub Pull Requests (https://github.com/microsoft/PR-Metrics/pulls) for proposed changes, and GitHub Discussions (https://github.com/microsoft/PR-Metrics/discussions) for general community conversation. All channels are publicly accessible.


    Enough for a badge!

    While active, the project documentation MUST include an explanation of the contribution process. [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.

    The CONTRIBUTING.md (https://github.com/microsoft/PR-Metrics/blob/main/.github/CONTRIBUTING.md) file documents the contribution process, including the Contributor License Agreement (CLA) requirement, coding style guidelines, instructions for updating and adding extensions, and how to communicate with the team. A pull request template (https://github.com/microsoft/PR-Metrics/blob/main/.github/pull_request_template.md) is also provided.


    Enough for a badge!

    While active, 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 project is licensed under the MIT License (https://github.com/microsoft/PR-Metrics/blob/main/LICENSE), which is approved by the Open Source Initiative (https://opensource.org/licenses/MIT).


    Enough for a badge!

    While active, 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.

    Released software artefacts are distributed under the same MIT License as the source code. The licence is OSI-approved.


    Enough for a badge!

    While active, the license for the source code MUST be maintained in the corresponding repository's LICENSE file, COPYING file, or LICENSE/ directory. [OSPS-LE-03.01]
    Include the project's source code license in the project's LICENSE file, COPYING file, 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 LICENSE file (https://github.com/microsoft/PR-Metrics/blob/main/LICENSE) is present in the repository root, containing the full MIT License text with the Microsoft Corporation copyright notice.


    Enough for a badge!

    While active, 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 release pipeline processes a LICENSE.txt for inclusion with release artefacts (via Update-Licenses.ps1). GitHub Releases automatically include the source code (with the LICENSE file) as downloadable archives alongside the VSIX artefact.


    Enough for a badge!

    While active, 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 code is publicly available at https://github.com/microsoft/PR-Metrics, a stable URL on GitHub.


    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 full Git commit history is publicly readable at https://github.com/microsoft/PR-Metrics, including author, date, and commit message for every change. Pull request history with review discussions is also publicly accessible.


    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.

    The package.json (https://github.com/microsoft/PR-Metrics/blob/main/package.json) and package-lock.json (https://github.com/microsoft/PR-Metrics/blob/main/package-lock.json) files enumerate all direct and transitive npm dependencies for the project.


    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.

    The project does not have any subprojects. It is a single codebase that produces artefacts for both GitHub Actions and Azure DevOps Pipelines via shared source code with platform-specific abstraction layers.


    Enough for a badge!

    While active, 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 repository does not contain generated executable binaries (e.g., .exe, .dll, .so, .jar). The dist/ folder contains text-based JavaScript files (index.mjs, exec-child.js) and metadata (lib.json, resources.resjson) required by the GitHub Actions runtime, which mandates committing compiled action code. These files are human-readable and reviewable. Build artefacts such as the VSIX package are generated at build time and published via CI/CD, not stored in version control.


    Enough for a badge!

    While active, 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.

    The only binary files in the repository are PNG images used for documentation illustrations and UI icons (in docs/images/ and src/images/). These are graphical assets, which are explicitly excluded from this control. No executable binaries, library files, or similar unreviewable artefacts are present.


    Enough for a badge!

    While active, 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.

    The SECURITY.md (https://github.com/microsoft/PR-Metrics/blob/main/SECURITY.md) file provides security vulnerability reporting instructions, directing reporters to the Microsoft Security Response Center (MSRC) at https://msrc.microsoft.com/create-report or via email at secure@microsoft.com. The file includes guidance on PGP encryption, expected response times, and the information to include in a report.


    Enough for a badge!

    (Obsolete criterion) When a CI/CD pipeline uses a branch name in its functionality, that name value MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.02]

    Where CI/CD workflows reference branch names in shell commands, values are passed through environment variables rather than direct expression interpolation. For example, in build.yml (https://github.com/microsoft/PR-Metrics/blob/main/.github/workflows/build.yml), github.head_ref is assigned to env.HEAD_REF and accessed via $Env:HEAD_REF in PowerShell, preventing script injection. Branch names used in action with: parameters (e.g., actions/checkout ref) are not subject to shell injection.



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

Project badge entry owned by: Muiris Woulfe.
Entry created on 2026-02-19 17:32:37 UTC, last updated on 2026-02-27 19:06:06 UTC. Last lost passing badge on 2026-02-23 14:15:17 UTC. Last achieved passing badge on 2026-02-23 14:43:51 UTC.