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

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

Sobre políticas de segurança

Para dar às pessoas instruções para relatar vulnerabilidades de segurança no seu projeto você pode adicionar um arquivo SECURITY.md à raiz do seu repositório, docs ou à pasta .github. Quando alguém criar um problema no seu repositório, a pessoa verá 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 README. Para obter mais informações, consulte "Sobre README".

Depois que alguém informar uma vulnerabilidade de segurança no seu projeto, você pode usar o Aviso de Segurança do GitHub para divulgar, corrigir e publicar informações sobre a vulnerabilidade. Para obter mais informações sobre o processo de relatórios e divulgação de vulnerabilidades em GitHub, consulte "Sobre divulgação coordenada das vulnerabilidades de segurança". Para obter mais informações sobre Aviso de Segurança do GitHub, consulte "Sobre Aviso de Segurança do 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 Política de segurança. Aba de política de segurança

  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. If you have more than one email address associated with your GitHub account, click the email address drop-down menu and select the email address to use as the Git author email address. 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ê?Política de Privacidade

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.