.github

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 na página do seu projeto! O status do selo se parece com isto: O nível do selo para o projeto 14058 é passing Aqui está como incorporá-lo:
Você pode mostrar o status do seu selo incorporando isto no seu arquivo markdown:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14058/badge)](https://www.bestpractices.dev/projects/14058)
ou incorporando isto no seu HTML:
<a href="https://www.bestpractices.dev/projects/14058"><img src="https://www.bestpractices.dev/projects/14058/badge"></a>


Estes são os critérios de nível Ouro. Você também pode visualizar os critérios de nível Aprovação ou Prata.

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

        

 Fundamentos 2/5

  • Geral

    Observe que outros projetos podem usar o mesmo nome.

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

    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.
  • Pré-requisitos


    O projeto DEVE alcançar um selo de nível prata. [achieve_silver]

  • Supervisão do projeto


    O projeto DEVE ter um "fator ônibus" de 2 ou mais. (URL obrigatória) [bus_factor]
    Um "bus factor" (também conhecido como "truck factor") é o número mínimo de membros do projeto que precisam desaparecer repentinamente de um projeto ("ser atropelados por um ônibus") antes que o projeto pare devido à falta de pessoal conhecedor ou competente. A ferramenta truck-factor pode estimar isso para projetos no GitHub. Para mais informações, consulte Assessing the Bus Factor of Git Repositories de Cosentino et al.

    The bus factor is 1 — a single maintainer. Recorded plainly in docs/slsa-reference.md as headcount-blocked, with docs/continuity.md carrying the succession and break-glass paths that exist precisely because of it. https://github.com/monumental-archive/.github/blob/main/docs/continuity.md



    O projeto DEVE ter pelo menos dois contribuidores significativos não associados. (URL obrigatória) [contributors_unassociated]
    Os contribuidores são associados se forem pagos para trabalhar pela mesma organização (como empregado ou contratado) e a organização se beneficia dos resultados do projeto. Concessões financeiras não contam como sendo da mesma organização se passarem por outras organizações (por exemplo, concessões científicas pagas a diferentes organizações de uma fonte governamental ou ONG comum não fazem com que os contribuidores sejam associados). Alguém é um contribuidor significativo se fez contribuições não triviais para o projeto no último ano. Exemplos de bons indicadores de um contribuidor significativo são: escreveu pelo menos 1.000 linhas de código, contribuiu com 50 commits, ou contribuiu com pelo menos 20 páginas de documentação.

    There is one significant contributor, so there cannot be two unassociated ones. Headcount, not policy: contributions are welcomed under CONTRIBUTING.md. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md


  • Outro


    O projeto DEVE incluir uma declaração de licença em cada arquivo-fonte. Isso PODE ser feito incluindo o seguinte dentro de um comentário perto do início de cada arquivo: SPDX-License-Identifier: [expressão de licença SPDX para o projeto]. [license_per_file]
    Isso PODE também ser feito incluindo uma declaração em linguagem natural identificando a licença. O projeto PODE também incluir uma URL estável apontando para o texto da licença, ou o texto completo da licença. Observe que o critério license_location requer que a licença do projeto esteja em um local padrão. Veja este tutorial SPDX para mais informações sobre expressões de licença SPDX. Observe a relação com copyright_per_file, cujo conteúdo normalmente precederia as informações de licença.

    Every file carries an SPDX licence statement (0BSD) through REUSE.toml, with the full text in LICENSES/0BSD.txt. reuse lint reports 141 of 141 files with licence information and api.reuse.software independently reports the project compliant. https://github.com/monumental-archive/.github/blob/main/REUSE.toml


 Controle de Mudanças 4/4

  • Repositório de código-fonte público controlado por versão


    O repositório de código do projeto DEVE usar um software de controle de versão distribuído comum (por exemplo, git ou mercurial). [repo_distributed]
    O Git não é especificamente exigido e os projetos podem usar software de controle de versão centralizado (como subversion) com justificativa.

    Git - a distributed version control system - hosted on GitHub. Every clone carries the complete history, and every commit and tree is content-addressed, so the record can be verified and republished from any clone independently of the hosting account. The repository is public and its history is the project's authoritative record; releases are cut from tags in that same history. https://github.com/monumental-archive/.github



    O projeto DEVE identificar claramente pequenas tarefas que podem ser realizadas por novos colaboradores ou colaboradores casuais. (URL obrigatória) [small_tasks]
    Esta identificação é tipicamente feita marcando problemas selecionados em um rastreador de problemas com uma ou mais tags que o projeto usa para o propósito, por exemplo, up-for-grabs, first-timers-only, "Small fix", microtask ou IdealFirstBug. Essas novas tarefas não precisam envolver a adição de funcionalidade; elas podem ser melhorar a documentação, adicionar casos de teste ou qualquer outra coisa que ajude o projeto e ajude o colaborador a entender mais sobre o projeto.

    Open issues are labelled 'good first issue' and 'help wanted': #4 (absorb the renovate-config repository and retire it) and #27 (stand up GitHub Sponsors and a FUNDING.yml). Both are self-contained and can be completed without prior context in the release machinery. https://github.com/monumental-archive/.github/labels/good%20first%20issue



    O projeto DEVE exigir autenticação de dois fatores (2FA) para desenvolvedores para alterar um repositório central ou acessar dados sensíveis (como relatórios de vulnerabilidade privados). Este mecanismo 2FA PODE usar mecanismos sem mecanismos criptográficos, como SMS, embora isso não seja recomendado. [require_2FA]

    Two-factor authentication is required organisation-wide — GitHub reports two_factor_requirement_enabled for the monumental-archive organisation — so it covers pushing to the repository and access to private vulnerability reports alike.



    A autenticação de dois fatores (2FA) do projeto DEVERIA usar mecanismos criptográficos para evitar personificação. A autenticação 2FA baseada em Short Message Service (SMS), por si só, NÃO atende a este critério, pois não é criptografada. [secure_2FA]
    Um mecanismo de 2FA que atende a este critério seria um aplicativo de Time-based One-Time Password (TOTP) que gera automaticamente um código de autenticação que muda após um determinado período de tempo. Observe que o GitHub suporta TOTP.

    The 2FA in use is cryptographic rather than SMS-based: GitHub's supported second factors here are TOTP and WebAuthn, and the organisation's requirement is satisfied without SMS.


 Qualidade 4/7

  • Padrões de codificação


    O projeto DEVE documentar seus requisitos de revisão de código, incluindo como a revisão de código é conduzida, o que deve ser verificado e o que é necessário para ser aceitável. (URL obrigatória) [code_review_standards]
    Veja também two_person_review e contribution_requirements.

    GOVERNANCE.md section 'Code review' documents how review is conducted and what must be checked: that the change does what it says, that the claim it makes is one its checks actually enforce, that it does not weaken a documented control, and that documentation changed alongside behaviour - with the mechanical floor (formatting, linting, licence headers, commit shape, tests) left to the CI gate rather than the reviewer. What is required to be acceptable is stated too: a green gate, resolved review threads enforced by ruleset, a DCO sign-off on every commit, and a PR title and body fit to become the permanent squash commit. It also records that with one maintainer there is no second human reviewer, and names the gate as the compensating control. https://github.com/monumental-archive/.github/blob/main/GOVERNANCE.md#code-review



    O projeto DEVE ter pelo menos 50% de todas as modificações propostas revisadas antes do lançamento por uma pessoa diferente do autor, para determinar se é uma modificação que vale a pena e livre de problemas conhecidos que argumentariam contra sua inclusão [two_person_review]

    With a single maintainer, no proposed modification is reviewed by a person other than its author. This is the Source L4 and Gold boundary for this project and is recorded as headcount-blocked in docs/slsa-reference.md; it is watched as an issue rather than papered over. https://github.com/monumental-archive/.github/blob/main/docs/slsa-reference.md


  • Sistema de compilação funcional


    O projeto DEVE ter uma compilação reproduzível. Se nenhuma compilação ocorrer (por exemplo, linguagens de script onde o código fonte é usado diretamente em vez de ser compilado), selecione "não aplicável" (N/A). (URL obrigatória) [build_reproducible]
    Uma compilação reproduzível significa que várias partes podem refazer independentemente o processo de geração de informações a partir de arquivos fonte e obter exatamente o mesmo resultado bit a bit. Em alguns casos, isso pode ser resolvido forçando algum tipo de ordenação. Desenvolvedores JavaScript podem considerar usar npm shrinkwrap e webpack OccurrenceOrderPlugin. Usuários de GCC e clang podem achar útil a opção -frandom-seed. O ambiente de compilação (incluindo o conjunto de ferramentas) pode frequentemente ser definido para partes externas especificando o hash criptográfico de um contêiner específico ou máquina virtual que eles podem usar para recompilar. O projeto de compilações reproduzíveis tem documentação sobre como fazer isso.

    The release is reproducible and it is proven on every release, not asserted. This repository publishes the source-archive class, so publish.yml builds the archive twice independently (build-source and repro-build-source) and the repro gate compares the two outputs bit for bit before anything is signed, attached or published — a mismatch fails the release rather than warning. A scheduled repro-check additionally re-verifies published history from cold. Verified on the live release: v1.22.2 ships github-1.22.2.tar.gz with checksums.txt and an attestations.intoto.jsonl evidence bundle. https://github.com/monumental-archive/.github/releases/tag/v1.22.2


  • Conjunto de testes automatizados


    Um conjunto de testes DEVE ser invocável de forma padrão para aquela linguagem. (URL obrigatória) [test_invocation]
    Por exemplo, "make check", "mvn test", ou "rake test" (Ruby).

    mise run ci — one command, identical locally and in CI, documented in README.md. https://github.com/monumental-archive/.github/blob/main/README.md



    O projeto DEVE implementar integração contínua, onde o código novo ou alterado é frequentemente integrado em um repositório de código central e testes automatizados são executados no resultado. (URL obrigatória) [test_continuous_integration]
    Na maioria dos casos, isso significa que cada desenvolvedor que trabalha em tempo integral no projeto integra pelo menos diariamente.

    gate.yml runs the full gate on every push and pull request to main, self-applying the reusable workflow this project publishes. https://github.com/monumental-archive/.github/blob/main/.github/workflows/gate.yml



    O projeto DEVE ter conjunto(s) de testes automatizados FLOSS que fornecem pelo menos 90% de cobertura de instrução se houver pelo menos uma ferramenta FLOSS que possa medir este critério na linguagem selecionada. [test_statement_coverage90]

    Statement coverage is not measured. The product is bash and YAML, and no coverage tool meets this project's tooling priors for bash (kcov is source-only and Linux-only); the verdict and its revisit trigger are recorded in docs/tooling-verdicts.md. https://github.com/monumental-archive/.github/blob/main/docs/tooling-verdicts.md



    O projeto DEVE ter conjunto(s) de testes automatizados FLOSS que fornecem pelo menos 80% de cobertura de ramos se houver pelo menos uma ferramenta FLOSS que possa medir este critério na linguagem selecionada. [test_branch_coverage80]

    Branch coverage is not measured, for the same reason as statement coverage: no bash coverage tool meets this project's priors. Recorded in docs/tooling-verdicts.md. https://github.com/monumental-archive/.github/blob/main/docs/tooling-verdicts.md


 Segurança 5/5

  • Usar práticas criptográficas boas e básicas

    Observe que alguns softwares não precisam usar mecanismos criptográficos. Se o seu projeto produzir software que (1) inclui, ativa ou habilita funcionalidade de criptografia, e (2) pode ser liberado dos Estados Unidos (EUA) para fora dos EUA ou para um não cidadão dos EUA, você pode ser legalmente obrigado a tomar algumas etapas extras. Normalmente isso envolve apenas o envio de um e-mail. Para mais informações, consulte a seção de criptografia de Understanding Open Source Technology & US Export Controls.

    O software produzido pelo projeto DEVE suportar protocolos seguros para todas as suas comunicações de rede, como SSHv2 ou posterior, TLS1.2 ou posterior (HTTPS), IPsec, SFTP e SNMPv3. Protocolos inseguros como FTP, HTTP, telnet, SSLv3 ou anterior, e SSHv1 DEVEM estar desabilitados por padrão, e apenas habilitados se o usuário configurá-lo especificamente. Se o software produzido pelo projeto não suportar comunicações de rede, selecione "não aplicável" (N/A). [crypto_used_network]

    All network communication is HTTPS — GitHub APIs, tool downloads, registry publishing, transparency-log submission. No insecure protocol appears anywhere in the tree, and certificate verification is never disabled.



    O software produzido pelo projeto DEVE, se suportar ou usar TLS, suportar pelo menos a versão 1.2 do TLS. Observe que o predecessor do TLS foi chamado SSL. Se o software não usar TLS, selecione "não aplicável" (N/A). [crypto_tls12]

    The software does not implement or configure TLS; it invokes tools (git, gh, curl) whose TLS versions are theirs.


  • Entrega protegida contra ataques man-in-the-middle (MITM)


    O site do projeto, repositório (se acessível via web) e site de download (se separado) DEVEM incluir cabeçalhos de fortalecimento chave com valores não permissivos. (URL obrigatória) [hardened_site]
    Observe que o GitHub e o GitLab são conhecidos por atender a isso. Sites como https://securityheaders.com/ podem verificar isso rapidamente. Os principais cabeçalhos de proteção são: Content Security Policy (CSP), HTTP Strict Transport Security (HSTS), X-Content-Type-Options (como "nosniff") e X-Frame-Options. Sites web totalmente estáticos sem capacidade de fazer login por meio das páginas web poderiam omitir alguns cabeçalhos de proteção com menos risco, mas não há maneira confiável de detectar tais sites, portanto exigimos esses cabeçalhos mesmo se forem sites totalmente estáticos.

    The project site is the GitHub repository itself, and it is served with key hardening headers - verified against the live URL: strict-transport-security: max-age=31536000; includeSubdomains; preload, content-security-policy: default-src 'none'; base-uri 'self', x-frame-options: deny, x-content-type-options: nosniff, referrer-policy: no-referrer-when-downgrade. There is no separate project website or download site to harden; releases are served from the same origin. https://github.com/monumental-archive/.github


  • Outras questões de segurança


    O projeto DEVE ter realizado uma revisão de segurança nos últimos 5 anos. Esta revisão DEVE considerar os requisitos de segurança e o limite de segurança. [security_review]
    Isso PODE ser feito pelos membros do projeto e/ou uma avaliação independente. Esta avaliação PODE ser apoiada por ferramentas de análise estática e dinâmica, mas também deve haver revisão humana para identificar problemas (particularmente no projeto) que as ferramentas não conseguem detectar.

    docs/build-assessment.md and docs/source-assessment.md are security reviews written against this project's own security requirements and boundary, control by control, and docs/slsa-reference.md records what is claimed and what is deliberately not. They are current, not historical: the scheduled audit re-checks the claims they rest on. https://github.com/monumental-archive/.github/blob/main/docs/build-assessment.md



    Mecanismos de proteção DEVEM ser usados no software produzido pelo projeto para que defeitos de software tenham menos probabilidade de resultar em vulnerabilidades de segurança. (URL obrigatória) [hardening]
    Os mecanismos de proteção podem incluir cabeçalhos HTTP como Content Security Policy (CSP), flags de compilador para mitigar ataques (como -fstack-protector), ou flags de compilador para eliminar comportamento indefinido. Para nossos propósitos, o privilégio mínimo não é considerado um mecanismo de proteção (privilégio mínimo é importante, mas separado).

    Least-privilege permissions on every workflow; an enforced capability boundary forbidding id-token: write in any workflow that runs caller-supplied code, checked by lint:capability-boundary in the gate; every action pinned to a full commit SHA with checksums and attestations; keyless publishing with no standing credentials; secret scanning with push protection enforced organisation-wide. Each mechanism is written up control by control, against the threat it answers, in docs/build-assessment.md. https://github.com/monumental-archive/.github/blob/main/docs/build-assessment.md


 Análise 1/2

  • Análise dinâmica de código


    O projeto DEVE aplicar pelo menos uma ferramenta de análise dinâmica a qualquer lançamento de produção proposto do software produzido pelo projeto antes de seu lançamento. [dynamic_analysis]
    Uma ferramenta de análise dinâmica examina o software executando-o com entradas específicas. Por exemplo, o projeto PODE usar uma ferramenta de fuzzing (por exemplo, American Fuzzy Lop) ou um scanner de aplicação web (por exemplo, OWASP ZAP ou w3af). Em alguns casos, o projeto OSS-Fuzz pode estar disposto a aplicar testes de fuzzing ao seu projeto. Para fins deste critério, a ferramenta de análise dinâmica precisa variar as entradas de alguma forma para procurar vários tipos de problemas ou ser um conjunto de testes automatizado com pelo menos 80% de cobertura de ramificação. A página da Wikipedia sobre análise dinâmica e a página da OWASP sobre fuzzing identificam algumas ferramentas de análise dinâmica. A(s) ferramenta(s) de análise PODEM estar focadas em procurar vulnerabilidades de segurança, mas isso não é obrigatório.

    Not met under this criterion's own definition, which requires a tool that varies its inputs, or an automated test suite with at least 80% branch coverage. The gate executes the shipped workflows and tasks on every pull request and release-lab runs the release path end to end, but neither varies inputs and branch coverage is not measured. CodeQL is static analysis and is claimed under static_analysis. Measuring branch coverage would close this criterion as well as the coverage ones.



    O projeto DEVERIA incluir muitas asserções em tempo de execução no software que produz e verificar essas asserções durante a análise dinâmica. [dynamic_analysis_enable_assertions]
    Este critério não sugere habilitar asserções durante a produção; isso é inteiramente decisão do projeto e de seus usuários. O foco deste critério é, em vez disso, melhorar a detecção de falhas durante a análise dinâmica antes da implantação. Habilitar asserções no uso em produção é completamente diferente de habilitar asserções durante a análise dinâmica (como testes). Em alguns casos, habilitar asserções no uso em produção é extremamente imprudente (especialmente em componentes de alta integridade). Existem muitos argumentos contra habilitar asserções em produção, por exemplo, bibliotecas não devem travar chamadores, sua presença pode causar rejeição por lojas de aplicativos e/ou ativar uma asserção em produção pode expor dados privados, como chaves privadas. Observe que em muitas distribuições Linux NDEBUG não é definido, então assert() em C/C++ será habilitado por padrão para produção nesses ambientes. Pode ser importante usar um mecanismo de asserção diferente ou definir NDEBUG para produção nesses ambientes.

    There is no compiled code with run-time assertion facilities to enable. The nearest equivalent is always on rather than configured: every task runs under set -euo pipefail and the belt's checks fail loudly rather than skip silently.



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 Carl Allen e aos contribuidores do selo de melhores práticas OpenSSF.

Entrada de selo do projeto de propriedade de: Carl Allen.
Entrada criada em 2026-08-13 07:47:41 UTC, última atualização em 2026-08-13 19:08:33 UTC. Selo de aprovação alcançado pela última vez em 2026-08-13 08:01:08 UTC.