Se você é um mantenedor de repositório, há várias maneiras de gerenciar e padronizar as pull requests que os colaboradores criam em seu repositório. Essas etapas podem ajudar você a garantir que as pull requests sejam revisadas pelas pessoas certas e que atendam aos padrões do repositório.
Usando modelos de pull request
Os modelos de pull request permitem personalizar e padronizar as informações que você gostaria de incluir quando alguém cria uma pull request em seu repositório. Quando você adicionar um modelo de pull request ao repositório, os contribuidores do projeto verão automaticamente o conteúdo do modelo no texto da pull request. Para saber mais, confira Criar modelos de pull request no repositório.
Você pode usar modelos de pull requests para padronizar o processo de revisão do repositório. Por exemplo, você pode incluir uma lista de tarefas que gostaria que os autores concluíssem antes de mesclar suas pull requests, adicionando uma lista de tarefas ao modelo. Para saber mais, confira Sobre listas de tarefas.
Você pode solicitar que os colaboradores incluam uma referência de problema no corpo da pull request, para que a mesclagem da pull request feche automaticamente o problema. Para saber mais, confira Vinculando uma pull request a um problema.
Definindo proprietários de código
Você talvez queira garantir que indivíduos específicos sempre revisem as alterações em determinados códigos ou arquivos em seu repositório. Por exemplo, talvez você queira garantir que um membro da equipe de segurança sempre examine as alterações em seu arquivo de SECURITY.md
ou dependabot.yml
.
Você pode definir indivíduos ou equipes que você considera responsáveis pelo código ou arquivos em um repositório como proprietários do código. Quando uma pull request que modifique um código pertencente aos proprietários do código for aberta, eles serão automaticamente solicitados a fazer a revisão. É possível definir proprietários de código para tipos específicos de arquivos ou diretórios, bem como para diferentes branches em um repositório. Para saber mais, confira Sobre os proprietários de código.
Usando branches protegidos
É possível usar branches protegidos para impedir que pull requests sejam mescladas em branches importantes, como main
, até que determinadas condições sejam atendidas. Por exemplo, você pode exigir uma revisão de aprovação ou exigir que todas as verificações de status sejam aprovadas. Confira Sobre branches protegidos.
Usando conjuntos de regras
Trabalhando com branches protegidos, os conjuntos de regras permitem que você imponha políticas em seu repositório, como exigir verificações de status ou fluxos de trabalho sejam aprovados antes que uma pull request possa ser mesclada.
Os conjuntos de regras são especialmente úteis para manter a segurança do repositório quando combinados com outras verificações de segurança automatizadas. Por exemplo:
- Você pode usar conjuntos de regras para impor a ação de revisão de dependência, um fluxo de trabalho que bloqueia pull requests que estão introduzindo dependências vulneráveis em sua base de código. Confira Aplicando a revisão de dependência em uma organização.
Usando ferramentas automatizadas para revisar o estilo do código
Use ferramentas automatizadas, como linters, nas pull requests do repositório para manter o estilo consistente e tornar o código mais compreensível. O uso de ferramentas automatizadas para detectar problemas menores, como erros de digitação ou estilo, deixa mais tempo para os revisores se concentrarem na substância de uma pull request.
Por exemplo, você pode usar GitHub Actions para configurar linters de código que possam ser executados em pull requests como parte do fluxo de trabalho de integração contínua (CI). Para saber mais, confira Sobre a integração contínua com o GitHub Actions.