DEV Community

Jhony Walker
Jhony Walker

Posted on

Hacks do Github - Commits que fecham issues

Commits

O Github é cheio de funcionalidades e o mais utilizado isso vocês já sabem e vamos continuar a série de "hacks" da plataforma que vão otimizar e melhorar sua experiência.

⚠️ Importante: Os prints que serão exibidos para exemplificar podem estar diferentes da interface do seu GitHub, por que sou muito adepto a extensões que melhoram a usabilidade e que ajudam no meu dia a dia. Partindo desse ponto peço que dê uma olhada nesse artigo antes.

Abre uma issue, resolve o problema, commita, faz o push, fecha a issue. Abre uma issue, resolve o problema, commita, faz o push, fecha a issue. E se eu te disse existe uma forma de automatizar esse processo?

Essa coisa de ficar lembrando de fechar a issue logo após a sua solução, em alguns casos, torna-se bastante chato e repetitivo. O Github tem um hack, onde você consegue fechar uma issue através de uma mensagem de commit.

Entendendo o hack

Você já deve saber que inglês é essencial hoje em dia. Quando codificamos, principalmente se pretendemos colaborar com projetos Open Source, deveríamos escrever seus nomes de funções, métodos, variáveis, entre outras coisas tudo em inglês, correto? Pois assim, mais pessoas poderão ter acesso ao projeto, já que inglês é uma linguagem mundial!

E com o Github não seria diferente, existe algumas palavras mágicas que podemos utilizar na mensagem de commit, para fechar uma issue. Precisamos referenciar também, o ID da issue (aquele número que aparece na URL quando você acessa a issue). E essss palavras mágicas são:

fix, fixes, fixed, close, closes, closed, resolve, resolves, resolved
Enter fullscreen mode Exit fullscreen mode

Então podemos escrever a mensagem de commit mais ou menos assim:

git commit -m "Fix error on issue #32"
Enter fullscreen mode Exit fullscreen mode

Usando uma das palavras mágicas, e referenciando a issue com a hash # + número/ID da issue, essas informações só precisam aparecer na mensagem de commit, não precisam ter uma ordem específica, nesse exemplo a issue #32 será fechada.

Essa é uma dica bem simples, mas que pode te poupar muito tempo com seus projetos open source.

Fontes onde pesquisei esse conteúdo:

Discussion (0)