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 a organização. Para obter mais informações, consulte "Criar arquivo padrão de integridade da comunidade para a organização".

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 arquivos LEIAME".

After someone reports a security vulnerability in your project, you can use GitHub Security Advisories to disclose, fix, and publish information about the vulnerability. For more information, see "About GitHub Security Advisories."

You can also join GitHub Security Lab to browse security-related topics and contribute to security tools and projects.

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

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

  2. Under your repository name, click Security.

    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. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    Mensagem do commit para sua alteração

  7. Below the commit message fields, click the email address drop-down menu and choose a Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then <username>@users.noreply.github.com is the default commit author email address. Para obter mais informações, consulte "Configurar o endereço de e-mail do commit".

    Choose commit email addresses

  8. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    Opções para fazer commit no branch

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

    Propose file change button

Leia mais

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato