Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Adicionar uma política de segurança ao repositório

Você pode dar instruções de como relatar de maneira responsável uma vulnerabilidade de segurança no seu projeto adicionando uma política de segurança ao repositório.

Neste artigo

Sobre políticas de segurança

Para dar às pessoas instruções de como relatar de maneira responsável vulnerabilidades de segurança no seu projeto, você pode adicionar um arquivo SECURITY.md à pasta raiz, docs ou .github do seu repositório. Quando uma pessoa cria um problema no seu repositório, ela vê um link para a política de segurança do seu projeto.

Você pode criar uma política de segurança padrão para sua organização ou conta de usuário. Para obter mais informações, consulte "Criando um arquivo padrão de integridade da comunidade."

Dica: para ajudar as pessoas a encontrar a política de segurança, você poderá vincular seu arquivo SECURITY.md a outros locais em seu repositório, como o arquivo LEIAME. Para obter mais informações, consulte "Sobre LEIAME".

Depois que alguém informar uma vulnerabilidade de segurança no seu projeto, você pode usar o Consultoria de segurança GitHub para divulgar, corrigir e publicar informações sobre a vulnerabilidade. Para obter mais informações, consulte "Sobre Consultoria de segurança GitHub".

Você também pode participar de Laboratório de Segurança GitHub para pesquisar tópicos relacionados a segurança e contribuir com ferramentas e projetos de segurança.

Adicionar uma política de segurança ao repositório

  1. No GitHub, navegue até a página principal do repositório.

  2. No seu nome de repositório, clique em Segurança.

    Guia de segurança

  3. Na barra lateral esquerda, clique em Policy (Política).

    Guia Policy (Política)

  4. Clique em Start setup (Iniciar configuração).

    Botão Start setup (Iniciar configuração)

  5. No novo arquivo SECURITY.md, adicione informações sobre versões compatíveis do seu projeto e como relatar uma vulnerabilidade.

  6. No final da página, digite uma mensagem de commit curta e significativa que descreva a alteração feita no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, consulte "Criar um commit com vários co-autores."

    Mensagem do commit para sua alteração

  7. Abaixo dos campos de mensagem de commit, clique no menu suspenso de endereço de e-mail e escolha um endereço de e-mail do autor do Git. Apenas endereços de e-mail verificados aparecem neste menu suspenso. Se você ativou a privacidade do endereço de e-mail, então <username>@users.noreply.github.com é o endereço de e-mail do autor de commit padrão. Para obter mais informações, consulte "Setting your commit email address."

    Escolha um endereço de e-mail commit

  8. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, consulte "Criar uma nova pull request."

    Opções para fazer commit no branch

  9. Clique em Propose file change (Propor alteração no arquivo).

    Botão Propose changes (Propor alterações)

Leia mais

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.