commitment-issues

Projetos que seguem as melhores práticas abaixo podem se autocertificar voluntariamente e mostrar que alcançaram um selo de melhores práticas da Open Source Security Foundation (OpenSSF).

Não existe um conjunto de práticas que possa garantir que o software nunca terá defeitos ou vulnerabilidades; mesmo métodos formais podem falhar se as especificações ou suposições estiverem erradas. Nem existe qualquer conjunto de práticas que possa garantir que um projeto sustentará uma comunidade de desenvolvimento saudável e bem-funcionada. No entanto, seguir as melhores práticas pode ajudar a melhorar os resultados dos projetos. Por exemplo, algumas práticas permitem revisão multipessoal antes do lançamento, o que pode ajudar a encontrar vulnerabilidades técnicas difíceis de encontrar e ajudar a construir confiança e desejo de interação repetida entre desenvolvedores de diferentes empresas. Para ganhar um selo, todos os critérios DEVE e NÃO DEVE devem ser atendidos, todos os critérios DEVERIA devem ser atendidos OU não atendidos com justificativa, e todos os critérios SUGERIDO devem ser atendidos OU não atendidos (queremos que sejam considerados pelo menos). Se você quiser inserir texto de justificativa como um comentário genérico, em vez de ser uma justificativa de que a situação é aceitável, inicie o bloco de texto com '//' seguido de um espaço. Feedback é bem-vindo via site do GitHub como questões ou pull requests Há também uma lista de discussão para discussão geral.

Fornecemos com prazer as informações em vários idiomas, no entanto, se houver qualquer conflito ou inconsistência entre as traduções, a versão em inglês é a versão autoritativa.
Se este é o seu projeto, por favor mostre o status do seu selo básico na página do seu projeto! O status do selo básico se parece com isto: O nível do selo básico para o projeto 13528 é baseline-1 Aqui está como incorporar o selo básico:
Você pode mostrar o status do seu selo básico incorporando isto no seu arquivo markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/13528/baseline)](https://www.bestpractices.dev/projects/13528)
ou incorporando isto no seu HTML:
<a href="https://www.bestpractices.dev/projects/13528"><img src="https://www.bestpractices.dev/projects/13528/baseline"></a>


Estes são os critérios de Nível Básico 2. Estes são critérios da versão v2026.02.19.

Baseline Series: Nível Básico 1 Nível Básico 2 Nível Básico 3

        

 Fundamentos

  • Geral

    Observe que outros projetos podem usar o mesmo nome.

    For developers who overthink every commit. Advisory-first pre-commit and pre-push checks for JavaScript and TypeScript projects using Husky, lint-staged, ESLint, and Prettier. Advisory by default: commitment-issues reports issues without discarding unstaged work, rewriting already-pushed history, or blocking pushes.

    Use o formato de expressão de licença SPDX; exemplos incluem "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT" e "(BSD-2-Clause OR Ruby)". Não inclua aspas simples ou aspas duplas.
    Se houver mais de uma linguagem, liste-as como valores separados por vírgula (espaços opcionais) e ordene-as da mais usada para a menos usada. Se houver uma longa lista, liste pelo menos as três primeiras mais comuns. Se não houver linguagem (por exemplo, este é um projeto apenas de documentação ou apenas de teste), use o caractere único "-". Use uma capitalização convencional para cada linguagem, por exemplo, "JavaScript".
    O Common Platform Enumeration (CPE) é um esquema de nomenclatura estruturado para sistemas de tecnologia da informação, software e pacotes. Ele é usado em vários sistemas e bancos de dados ao relatar vulnerabilidades.

 Controles 16/19 ●

  • Controles


    Suficiente para um badge!

    Quando uma tarefa de CI/CD é executada sem permissões especificadas, o sistema de CI/CD DEVE definir como padrão as permissões da tarefa para as menores permissões concedidas no pipeline. [OSPS-AC-04.01]
    Configure as definições do projeto para atribuir as menores permissões disponíveis a novos pipelines por padrão, concedendo permissões adicionais somente quando necessário para tarefas específicas.

    Suficiente para um badge!

    Quando um lançamento oficial é criado, esse lançamento DEVE receber um identificador de versão único. [OSPS-BR-02.01]
    Atribua um identificador de versão único a cada versão de lançamento produzida pelo projeto, seguindo uma convenção de nomenclatura ou esquema de numeração consistente. Exemplos incluem SemVer, CalVer ou id de commit git.

    Each release intended for users has a unique semantic version identifier in package.json, such as 3.0.1. The release workflow is triggered by version tags matching v* and verifies that the Git tag matches the package.json version before publishing. This ensures user-facing releases are uniquely identified.

    https://github.com/RoryGlenn/commitment-issues/blob/main/package.json [version_unique]


    Suficiente para um badge!

    Quando um lançamento oficial é criado, esse lançamento DEVE conter um registro descritivo de modificações funcionais e de segurança. [OSPS-BR-04.01]
    Certifique-se de que todos os lançamentos incluam um registro de alterações descritivo. É recomendado garantir que o registro de alterações seja legível por humanos e inclua detalhes além das mensagens de commit, como descrições do impacto de segurança ou relevância para diferentes casos de uso. Para garantir a legibilidade por máquina, coloque o conteúdo sob um cabeçalho markdown como \"## Changelog\"."

    Non-trivial release notes file in repository: https://github.com/RoryGlenn/commitment-issues/blob/main/CHANGELOG.md. [release_notes]


    Suficiente para um badge!

    Quando um pipeline de compilação e lançamento ingere dependências, ele DEVE usar ferramentas padronizadas quando disponíveis. [OSPS-BR-05.01]
    Use ferramentas comuns para o seu ecossistema, como gerenciadores de pacotes ou ferramentas de gerenciamento de dependências para ingerir dependências no momento da compilação. Isso pode incluir o uso de um arquivo de dependências, arquivo de bloqueio ou manifesto para especificar as dependências necessárias, que são então incorporadas pelo sistema de compilação.

    The project lists external dependencies in computer-processable npm metadata. package.json declares runtime dependencies, development dependencies, peer dependencies, and the supported Node engine, while package-lock.json records resolved dependency versions, integrity hashes, licenses, and transitive dependency metadata. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/package.json and https://github.com/RoryGlenn/commitment-issues/blob/main/package-lock.json. [external_dependencies]


    Suficiente para um badge!

    Quando um lançamento oficial é criado, esse lançamento DEVE ser assinado ou contabilizado em um manifesto assinado incluindo os hashes criptográficos de cada ativo. [OSPS-BR-06.01]
    Assine todos os ativos de software lançados no momento da construção com uma assinatura criptográfica ou atestados, como assinatura GPG ou PGP, assinaturas Sigstore, proveniência SLSA ou VSAs SLSA. Inclua os hashes criptográficos de cada ativo em um manifesto assinado ou arquivo de metadados.

    Already publishing with npm publish --provenance, npm generates a Sigstore attestation for the published package. If GitHub Release assets are also published, they should either be signed or accompanied by a signed manifest containing their hashes.


    Insuficiente para um badge.

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir uma descrição de como o projeto seleciona, obtém e rastreia suas dependências. [OSPS-DO-06.01]
    É recomendado publicar essas informações juntamente com a documentação técnica e de design do projeto em um recurso publicamente visível, como o repositório de código-fonte, site do projeto ou outro canal.

    No / In progress.

    The project uses the standard npm ecosystem for dependency management, including package.json, package-lock.json, and npm ci. However, the project documentation does not yet include a dedicated description of how dependencies are selected, obtained, and tracked.

    To satisfy this requirement, the project will add dependency-management documentation describing:

    • how dependencies are selected;
    • how dependencies are obtained;
    • how dependency versions are locked and tracked;
    • how dependency updates are reviewed;
    • how security advisories and vulnerability fixes are handled.

    Suficiente para um badge!

    A documentação do projeto DEVE incluir instruções sobre como compilar o software, incluindo bibliotecas, frameworks, SDKs e dependências necessários. [OSPS-DO-07.01]
    Recomenda-se publicar essas informações junto com a documentação de colaboradores do projeto, como em CONTRIBUTING.md ou outra documentação de tarefas de desenvolvimento. Isso também pode ser documentado usando alvos de Makefile ou outros scripts de automação.

    The project provides a quick, common development setup using git and npm. Potential developers can fork and clone the repository, run npm install, then verify the development/test environment with npm test, npm run lint, and npm run format:check. The contributing guide also documents how to run the full test suite and individual test files. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#getting-started. [installation_development_quick]


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma lista de membros do projeto com acesso a recursos sensíveis. [OSPS-GV-01.01]
    Documente os participantes do projeto e seus papéis através de artefatos como members.md, governance.md, maintainers.md ou arquivo similar dentro do repositório de código-fonte do projeto. Isso pode ser tão simples quanto incluir nomes ou identificadores de conta em uma lista de mantenedores, ou mais complexo dependendo da governança do projeto.

    The project maintains documentation identifying the individuals with access to sensitive project resources, including repository administration, release publishing, package publishing, security settings, and signing credentials. This documentation is kept up to date while the project is active.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir descrições dos papéis e responsabilidades dos membros do projeto. [OSPS-GV-01.02]
    Documente os participantes do projeto e seus papéis através de artefatos como members.md, governance.md, maintainers.md ou arquivo similar dentro do repositório de código-fonte do projeto.

    The project documentation defines the roles and responsibilities for each project member. This includes responsibilities for project governance, reviewing contributions, approving and publishing releases, responding to security reports, maintaining project documentation, managing CI/CD and repository settings, and maintaining dependencies. The documentation is kept current as project membership changes.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir um guia para contribuidores de código que inclui requisitos para contribuições aceitáveis. [OSPS-GV-03.02]
    Estenda o conteúdo de CONTRIBUTING.md ou CONTRIBUTING/ na documentação do projeto para delinear os requisitos para contribuições aceitáveis, incluindo padrões de codificação, requisitos de testes e diretrizes de submissão para contribuidores de código. É recomendado que este guia seja a fonte da verdade tanto para contribuidores quanto para aprovadores.

    The contributing guide documents requirements for acceptable contributions. Pull requests should include tests for behavior changes and regression tests for bug fixes, stay focused to one logical change, pass npm test, npm run lint, and npm run format:check, update the changelog and documentation for user-visible changes, and follow the project's advisory-first design philosophy. The guide also documents the coding style: Prettier for formatting, ESLint flat config for linting, small composable functions, clear names, and comments only where intent is non-obvious.

    https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#contribution-requirements [contribution_requirements]


    Insuficiente para um badge.

    Enquanto ativo, o sistema de controle de versão DEVE exigir que todos os contribuidores de código afirmem que estão legalmente autorizados a fazer as contribuições associadas em cada commit. [OSPS-LE-01.01]
    Inclua um DCO no repositório do projeto, exigindo que os contribuidores de código afirmem que estão legalmente autorizados a confirmar as contribuições associadas em cada commit. Use uma verificação de status para garantir que a afirmação seja feita. Um CLA também satisfaz este requisito. Alguns sistemas de controle de versão, como o GitHub, podem incluir isso nos termos de serviço da plataforma.

    The project currently states that contributions are licensed under the MIT License, but it does not yet document a DCO, CLA, Signed-off-by requirement, or equivalent contributor authorization mechanism. Current partial contribution/legal language is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#opening-a-pull-request. [dco]


    Suficiente para um badge!

    Quando um commit é feito na branch primária, quaisquer verificações de status automatizadas para commits DEVEM passar ou ser manualmente ignoradas. [OSPS-QA-03.01]
    Configure o sistema de controle de versão do projeto para exigir que todas as verificações de status automatizadas passem ou exijam reconhecimento manual antes que um commit possa ser mesclado na branch primária. É recomendado que quaisquer verificações de status opcionais NÃO sejam configuradas como um requisito de aprovação ou reprovação que os aprovadores possam ser tentados a ignorar.

    The project applies an automated test suite on each check-in to the shared repository through GitHub Actions. The CI workflow runs on pushes to main and pull requests, and it reports success or failure for linting, formatting, automated tests, package lifecycle smoke tests, coverage, and package-manager smoke tests. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/workflows/ci.yml. [automated_integration_testing]


    Suficiente para um badge!

    Antes de um commit ser aceito, os pipelines de CI/CD do projeto DEVEM executar pelo menos um conjunto de testes automatizados para garantir que as alterações atendam às expectativas. [OSPS-QA-06.01]
    Testes automatizados devem ser executados antes de cada mesclagem na branch primária. O conjunto de testes deve ser executado em um pipeline de CI/CD e os resultados devem ser visíveis a todos os contribuidores. O conjunto de testes deve ser executado em um ambiente consistente e deve ser executado de uma maneira que permita aos contribuidores executar os testes localmente. Exemplos de conjuntos de testes incluem testes unitários, testes de integração e testes de ponta a ponta.

    The project applies an automated test suite on each check-in to the shared repository through GitHub Actions. The CI workflow runs on pushes to main and pull requests, and it reports success or failure for linting, formatting, automated tests, package lifecycle smoke tests, coverage, and package-manager smoke tests. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/workflows/ci.yml. [automated_integration_testing]


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir documentação de design demonstrando todas as ações e atores dentro do sistema. [OSPS-SA-01.01]
    Inclua designs na documentação do projeto que expliquem as ações e atores. Atores incluem qualquer subsistema ou entidade que possa influenciar outro segmento no sistema. Certifique-se de que isso seja atualizado para novos recursos ou mudanças que quebrem compatibilidade.

    The project documents its high-level architecture and public interface through the contributing guide and external interface reference. The contributing guide describes the project layout, including entry-point scripts, shared helper modules, tests, docs, and CI workflows. The external interface reference documents CLI commands, init-added scripts, Git hook entrypoints, configuration keys/defaults, output behavior, and exit behavior. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#project-layout and https://github.com/RoryGlenn/commitment-issues/blob/main/docs/external-interface.md [documentation_architecture]


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir descrições de todas as interfaces de software externas dos ativos de software lançados. [OSPS-SA-02.01]
    Documente todas as interfaces de software (APIs) dos ativos de software lançados, explicando como os usuários podem interagir com o software e quais dados são esperados ou produzidos. Certifique-se de que isso seja atualizado para novos recursos ou mudanças que quebrem compatibilidade.

    [documentation_interface]


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, o projeto DEVE realizar uma avaliação de segurança para compreender os problemas de segurança potenciais mais prováveis e impactantes que poderiam ocorrer dentro do software. [OSPS-SA-03.01]
    Realizar uma avaliação de segurança informa tanto os membros do projeto quanto os consumidores a jusante que o projeto compreende quais problemas poderiam surgir dentro do software. Compreender quais ameaças poderiam se concretizar ajuda o projeto a gerenciar e tratar riscos. Essa informação é útil para os consumidores a jusante demonstrarem a perspicácia e as práticas de segurança do projeto. Certifique-se de que isso seja atualizado para novos recursos ou mudanças disruptivas.

    The project performed a documented security review on 2026-07-08. The review considered the security boundary: commitment-issues runs locally in user repositories, shells out to local tools such as ESLint, Prettier, and the configured test runner, reads local Git state/files, does not expose a network service, and does not transmit repository content. The review covered CLI entrypoints, shared helpers, Git hook wiring, pre-commit/pre-push execution paths, and release/CI workflows. [security_review]


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma política para divulgação coordenada de vulnerabilidades (CVD), com um prazo claro para resposta. [OSPS-VM-01.01]
    Crie um arquivo SECURITY.md na raiz do diretório, descrevendo a política do projeto para divulgação coordenada de vulnerabilidades. Inclua um método para relatar vulnerabilidades. Estabeleça expectativas sobre como o projeto responderá e tratará problemas relatados.

    The project publishes its vulnerability reporting process in SECURITY.md: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/SECURITY.md. The policy tells users how to report vulnerabilities privately through GitHub Security Advisories, asks reporters not to open public issues for suspected vulnerabilities, and explains what details to include in a report. [vulnerability_report_process]


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE fornecer um meio para relato privado de vulnerabilidades diretamente aos contatos de segurança dentro do projeto. [OSPS-VM-03.01]
    Forneça um meio para que pesquisadores de segurança relatem vulnerabilidades privadamente ao projeto. Isso pode ser um endereço de e-mail dedicado, um formulário web, ferramentas especializadas do VCS, endereços de e-mail para contatos de segurança ou outros métodos.

    The project supports private vulnerability reports and documents how to send them privately in SECURITY.md: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/SECURITY.md. The policy instructs reporters to use GitHub's private vulnerability reporting / Security Advisories flow and explicitly says not to open a public issue for suspected vulnerabilities. [vulnerability_report_private]


    Insuficiente para um badge.

    Enquanto ativo, a documentação do projeto DEVE publicar publicamente dados sobre vulnerabilidades descobertas. [OSPS-VM-04.01]
    Forneça informações sobre vulnerabilidades conhecidas em um canal público previsível, como uma entrada CVE, postagem em blog ou outro meio. Na medida do possível, essa informação deve incluir versão(ões) afetada(s), como um consumidor pode determinar se está vulnerável e instruções para mitigação ou remediação.

    To satisfy this requirement, the project will maintain a public vulnerability history (for example, docs/vulnerability-history.md or GitHub Security Advisories) documenting all disclosed vulnerabilities. If no vulnerabilities have been discovered, the documentation will explicitly state that no publicly disclosed vulnerabilities have been reported to date and will be updated as future disclosures occur.



Estes dados estão disponíveis sob o Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Isso significa que um Destinatário de Dados pode compartilhar os Dados, com ou sem modificações, desde que o Destinatário de Dados disponibilize o texto deste acordo com os Dados compartilhados. Por favor, dê crédito a RoryGlenn e aos contribuidores do selo de melhores práticas OpenSSF.

Entrada de selo do projeto de propriedade de: RoryGlenn.
Entrada criada em 2026-07-08 02:38:47 UTC, última atualização em 2026-07-09 21:04:40 UTC. Selo de aprovação alcançado pela última vez em 2026-07-09 17:43:22 UTC.