Exercício – Criar o primeiro pedido Pull

  • 6 minutos

Aprendeu a criar um pedido Pull (PP) com a documentação de orientação relevante, num modelo de pedido Pull ou num ficheiro CONTRIBUTING. E se um projeto não oferecer a orientação e a documentação sobre as convenções?

Descrever as suas alterações

Para escrever uma boa mensagem de consolidação e, subsequentemente, o pedido Pull, siga estas práticas:

  • A linha de assunto da mensagem de confirmação do Git deve completar a seguinte frase:
    • Se for aplicada, esta consolidação irá <your subject line here> (o assunto da mensagem aqui).
  • Inclua uma descrição sucinta da alteração através do presente do imperativo. Por exemplo, use adicionar não adicionado ou adiciona.
  • Limite o assunto da mensagem a 50 carateres.
  • Comece com letra maiúscula e não termine com um ponto (.).
  • Você pode usar emojis ou @mention outros usuários do GitHub em sua linha de assunto, mas esteja ciente de que nem todos os projetos permitem ou incentivam isso.

Para o corpo da sua mensagem e pedido Pull, continue a utilizar o tempo presente. Certifique-se de que inclui o motivo para a alteração. Compare a sua alteração com o comportamento anterior. Use o espaço à sua disposição para explicar o quê e porquê versus o como.

A mensagem de consolidação é tão sucinta como o conteúdo que está prestes a submeter. Consolide ou submeta para rever pequenos conjuntos isolados de alterações. Esta prática também aumenta a probabilidade de as alterações serem incluídas no projeto.

Adicionar granularidade

Antes de enviar o pedido Pull, procure formas de o concluir na barra lateral. Selecione Revisores ou Cessionários se estiver familiarizado com a estrutura da equipe do projeto. Adicione rótulos quando houver orientação sobre o uso de rótulos, por exemplo, no arquivo CONTRIBUTING.md. Pode utilizar etiquetas como uma ajuda visual para o que está a tentar fazer. Um responsável pela manutenção também pode adicionar uma ou múltiplas etiquetas.

Sugestão

Se o repositório tiver um arquivo CONTRIBUTING.md ou um modelo de RP, siga suas orientações ao preencher sua solicitação pull.

Algumas das etiquetas que utilizamos no repositório deste módulo do Learn são:

  • Bug (vermelho): Algo não está funcionando
  • Documentação (azul): Melhorias ou adições à documentação
  • Duplicado (cinza): esse problema ou solicitação pull já existe
  • Aprimoramento (azul): novo recurso ou solicitação

Opcionalmente, você pode vincular problemas na barra lateral, onde mesclar com êxito uma solicitação pull pode fechar o problema correspondente. Você também pode personalizar sua assinatura para notificações no tópico. Alguns RPs recebem muitos comentários, avaliações e notificações relacionadas a CI/CD. Pode escolher entre:

  • Não subscrito: Receba notificações apenas quando tiver participado ou estado @mentioned
  • Subscrito: Receba todas as notificações para este pull request
  • Personalizado: Seja notificado apenas para os eventos selecionados

Exercício

Usando o projeto First Contributions, pratique fazer fork, clonar e submeter um pull request. O projeto First Contributions tem como objetivo "orientar a forma como os principiantes dão a sua primeira contribuição". Ele tem guias para usar a linha de comando e várias interfaces gráficas do usuário (GUIs). O projeto também tem apoio ao cliente em vários idiomas. Certifique-se de que verifica a pasta Translations.

Com as lições desta unidade e da anterior em mente, volte a um pedido Pull que tenha aberto recentemente. Em alternativa, pode aceder ao separador dos pedidos Pull de um projeto que esteja a acompanhar. Repare como um bom assunto da mensagem pode fazer toda a diferença. Recomendamos que atualize um pedido Pull em conformidade. Dedique quase tanto tempo à escrita do seu PP quanto dedicou a fazer a alteração ao projeto. Os seus esforços irão ajudar os responsáveis pela manutenção a categorizar e a dar prioridade (fazer a triagem) às contribuições da comunidade.

Bônus: Consulte as diretrizes e requisitos de acessibilidade da Microsoft. Em particular, consulte as informações sobre como descrever interações com a interface do usuário para evitar linguagem capacitista em suas contribuições. Os clientes interagem com os produtos através de diferentes métodos de entrada. Por exemplo, podem utilizar o teclado, um rato, toque, voz e mais. É preferível que utilize verbos genéricos que funcionem com qualquer método de entrada. Por exemplo, use selecionar em vez de clicar ou deslizar, que são específicos para a interação de entrada.