Como criar problemas no GitHub 5 vezes mais rápido

Os problemas do GitHub são fantásticos para rastrear novos recursos ou bugs, quem é atribuído, categorizá-los, adicionar a projetos e assim por diante. Ao mesmo tempo, eles também são muito lentos para criar e criar um monte deles consome muito tempo.

Um dos pontos problemáticos que vejo nos problemas do GitHub no trabalho é que eles são complicados de criar, principalmente para aqueles que não são desenvolvedores ou designers, como gerentes ou testadores, que desejam relatar um bug sem passar pelo processo de criá-los no GitHub.

Há algum tempo , escrevi sobre um aplicativo que estava escrevendo para acelerar a criação de problemas no GitHub. Na verdade, eu construo o aplicativo, mas esqueci de escrever sobre isso aqui, então aqui está o post apropriado no blog. Neste post veremos:

2. Escrevendo um lote de problemas do GitHub com texto simples
3. A pilha de tecnologia por trás do aplicativo
4. Mais ideias para melhorar a criação de questões

Por que um aplicativo para criar problemas do GitHub mais rapidamente?

A IU do GitHub geralmente está correta para criar um problema. Ou dois. E tudo bem para pessoas com experiência em tecnologia, como desenvolvedores ou designers. No entanto, em nossa empresa Reconnect, às vezes, após desenvolvermos um novo recurso, solicitamos que nossa equipe não técnica o teste. E isso funciona muito bem, porque eles geralmente encontram alguns problemas. Mas é muito demorado para eles irem e pularem pela interface do usuário de problemas do GitHub. Isso é ainda mais complicado quando eles precisam criar mais de um problema e provavelmente em repositórios diferentes.

Se quantificarmos o número de vezes que mudamos nossa atenção para criar problemas no GitHub depois de chegarmos à página para criar um problema no repositório onde queremos criá-los, seria algo mais ou menos assim:

• digite o título
• vá para a caixa de texto do problema para inserir a descrição
• vá para a barra lateral para atribuir o problema a alguém
• vá para o bloco Rótulos na barra lateral para adicionar um rótulo
• vá e clique no botão para realmente criar o problema

São 5 vezes quando mudamos nossa atenção de uma área para outra! Muita mudança de atenção para uma tarefa que é essencialmente escrita e muito tempo gasto refocalizando. E se você tiver que escrever um problema em um repositório diferente? Você precisa navegar para esse repositório em uma nova guia ou na atual e isso é mais tempo perdido.

Então, como você pode criar problemas no GitHub com mais facilidade e rapidez? Não seria mais fácil se pudéssemos fazê-lo focado em um único lugar sem ter que mudar nossa atenção várias vezes?

Escrevendo um lote de problemas do GitHub com texto simples

A escrita é uma das habilidades mais básicas nos dispositivos, é mais básica do que os gestos de toque. Porque, embora sejam específicos para dispositivos de toque, você precisa usar um mouse ou um trackpad em outros. Mas a escrita geralmente é sempre a mesma. E os problemas do GitHub são texto, então por que não usar texto para criá-los sem sair do teclado?

Este aplicativo faz exatamente isso: https://fast-issues.herokuapp.com/

Você autoriza este aplicativo GitHub e pode começar a escrever problemas em todos os seus repositórios. Você só precisa selecionar um repositório onde deseja criar um problema e começar a escrever vários problemas, um em cada linha.

E suporta escrever o título e a descrição, atribuí-lo e rotulá-lo. Requer apenas o título da edição. O resto é tudo opcional. Você só precisa seguir uma certa convenção:

• o título vem primeiro
• em seguida, um caractere de barra vertical separa os responsáveis. Escolhi assim porque, no mínimo, você precisa de um problema e de alguém para trabalhar nele
• um segundo caractere de barra vertical separa a descrição do problema. Pode ter qualquer comprimento, mas não pode ter quebras de linha porque isso iniciaria um novo problema
• um terceiro caractere de barra vertical separa os rótulos

Ele oferece suporte a vários destinatários e rótulos, separando-os usando uma vírgula. Então, basicamente:

This is the title | username1, username2 | This is the issue description, as long as you want it but without line breaks. | Label 1, Label 2<br>This is another issue | username3 | And another issue description | Bug

Uma vez feito, é uma questão de clicar no botão Go! botão e ele irá criar todos os problemas. Cada um terá você como autor. Mais tarde, você pode editá-los para adicionar imagens ou vídeos, memes, qualquer coisa.

Se você precisar criar mais problemas em um repositório diferente, basta selecioná-lo novamente no menu suspenso e começar a escrever esses problemas. Chega de pular páginas!

A pilha de tecnologia por trás do aplicativo

O repositório para este aplicativo está localizado em https://github.com/eliorivero/fast-issues

A pilha de tecnologia é particularmente simples e inteiramente baseada em JavaScript :

• frontend construído com React
• back-end criado com Node.js
• usa Express como o servidor
• e Octokit REST uma biblioteca para trabalhar com a API do GitHub

Uma coisa a ter em mente é que não queremos ultrapassar o limite de solicitações permitidas pela API de problemas do GitHub. Eles recomendam deixar passar pelo menos um segundo entre as solicitações, então pausei a execução 1,5 segundos entre a criação de cada problema.

Do protótipo inicial que fiz até a versão final, mudei de um aplicativo GitHub para um aplicativo OAuth. É porque este último permite que você crie problemas e apareça como autor.

Mais ideias para melhorar a criação de questões

Mostrei isso a um amigo e ele me disse que tinha a ideia de criar uma extensão do Chrome para tirar uma captura de tela de um bug, anotá-lo e enviá-lo como um problema do GitHub. Achei uma ótima ideia, então procurei uma maneira de fazer uma captura de tela, mas dentro de um aplicativo React e rapidamente encontrei o html2canvas que permite fazer capturas de tela e salvá-las como arquivos PNG.

Combinar algo assim com minha ferramenta para criar os problemas seria uma boa solução que poderia estar disponível em um aplicativo React durante seu ciclo de desenvolvimento ou teste. Qualquer pessoa que teste o aplicativo pode acionar o painel de relatórios de problemas e enviar um problema do GitHub.

O único problema com isso por enquanto é que a API do GitHub não permite o upload de imagens, então elas teriam que ser hospedadas em outro lugar e ter o link para esse local inserido nesta ferramenta, mas definitivamente é uma boa melhoria.

Então, novamente, o aplicativo está em https://fast-issues.herokuapp.com/ e se você acabar usando, deixe-me saber sobre isso nos comentários.