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 Aviso de Segurança do GitHub para divulgar, corrigir e publicar informações sobre a vulnerabilidade. Para obter mais informações, 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
-
No GitHub, navegue até a página principal do repositório.
-
No seu nome de repositório, clique em Segurança.
-
Na barra lateral esquerda, clique em Policy (Política).
-
Clique em Start setup (Iniciar configuração).
-
No novo arquivo SECURITY.md, adicione informações sobre versões compatíveis do seu projeto e como relatar uma vulnerabilidade.
-
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."
-
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." -
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."
-
Clique em Propose file change (Propor alteração no arquivo).