Não há nada mais frustrante do que receber um relatório de bug incompleto. Já vi muitas vezes relatórios de bugs contendo um inútil “{x} feature doesn’t work” (o recurso {x} não funciona); sem etapas para reproduzir, sem URL, sem informações sobre o navegador ou o dispositivo, apenas uma mensagem desesperadamente vaga. O mesmo acontece quando o senhor recebe um pull request ou um patch que não declara sua intenção e não fornece etapas de teste (e quanto aos testes de unidade?). Agora que muitos projetos são públicos, a maioria no GitHub, tenho visto um aumento maciço nesses tipos de problemas e solicitações pull pouco documentados.


Recentemente, descobri que é possível criar modelos de pull request e de problemas para que, quando o usuário for registrar um pull request ou um problema, o modelo seja exibido na área de texto da descrição. Vamos dar uma olhada em como podemos fazer isso!


Criação de arquivos de modelo


É fácil criar e colocar em prática os arquivos de modelo:

  • O local adequado para colocar os arquivos de modelo é em um arquivo .github na raiz do seu repositório
  • Os modelos devem ser criados no formato markdown
  • O texto do modelo de questões vai em um ISSUE_TEMPLATE.md arquivo
  • O texto do modelo de pull requests vai para um PULL_REQUEST_TEMPLATE.md arquivo

Um ótimo exemplo de uso de modelo pode ser visto no repositório A-Frame. O modelo de problema é o seguinte:



**Description:**

- A-Frame Version:
- Platform / Device:
- Reproducible Code Snippet or URL:

<!-- If you have a support question, please ask at https://stackoverflow.com/questions/ask/?tags=aframe rather than filing an issue. -->


Se os repositórios da sua comunidade sofrem com a falta de informações em problemas e pull requests, ou se o senhor simplesmente deseja evitar o problema, crie modelos do GitHub para desenvolvedores. Eles podem não fornecer as informações que você gostaria, mas você pode pelo menos empurrá-los na direção correta!

  • Criar URLs do Digg usando PHP

    Recentemente, o Digg lançou um novo recurso que permite que os usuários criem URLs minúsculos do Digg, que mostram um banner do Digg na parte superior, permitindo fácil acesso para votar no artigo a partir da página. Embora eu adore visitar o Digg de vez em quando…

  • jQuery Wookmark

    A primeira coisa que acontece quando o senhor visita o Pinterest é: “Uau, as colunas têm a mesma largura e as fotos são cortadas para caber do jeito que devem”. Os usuários básicos da Web provavelmente não pensam nisso, mas, como desenvolvedor, posso apreciar a…