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

Depois que um indivíduo relata uma vulnerabilidade de segurança no seu projeto, você pode criar uma consultoria de segurança do mantenedor para divulgar, corrigir e publicar informações sobre a vulnerabilidade. Para obter mais informações, consulte "Sobre consultorias de segurança do mantenedor".

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

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Security.

    Security tab

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

    Commit message for your change

  1. 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. For more information, see "Setting your commit email address."

    Choose commit email addresses

  2. Below the commit message fields, decide whether to add your commit to the current branch or to a new 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."

    Commit branch options

  3. Click Propose file change.

    Propose file change button

Leia mais

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato