/Desenvolvimento

voltar
/Desenvolvimento

5 dicas sobre issues e comentários no GitHub

PorDiego Pinho em

Hoje em dia você dificilmente encontrará um programador que não conhece o GitHub. A plataforma de versionamento sob o controle de versão git é usada ao redor do mundo inteiro, tanto para projetos pessoais, quanto comerciais. Estima-se que o serviço possui mais de 3 milhões de usuários ativos mundialmente e abriga mais de 65 milhões de projetos. Não é pouca coisa.

Mas apesar de ser usada no mundo todo, há algumas features que poucas pessoas conhecem. Neste artigo, vou mostrar algumas dicas e truques sobre o GitHub em relação à issues e comentários para que você tire o máximo de proveito.

Dica 1 – Imagens

Há vários aspectos bacanas em relação a comentários e issues no GitHub. A primeira delas é que a plataforma possui uma inteligência para quando queremos colocar imagens. Sabe quando você está usando o Word, por exemplo, e quer colocar uma imagem no seu texto? Você vai na internet, copia a imagem e simplesmente cola, certo? No GitHub é possível fazer a mesma coisa!

Ao colar a imagem, o GitHub faz o upload da imagem na nuvem e gera o link em markdown.

Dica 2 – Formatação de Código

Outro aspecto bem interessante é a formatação de código. Para que o GitHub consiga renderizar corretamente a sintaxe do trecho de código, basta utilizarmos a declaração de código em blocos de acordo com a sintaxe do Markdown. Veja este exemplo:

Dica 3 – Fechar issues com palavras mágicas

Essa dica é uma mão na roda. Imagine que você esteja criando uma pull request para corrigir a issue #33 de um projeto. Se você colocar o texto “fixes #33” na descrição da sua PR, quando ela for mergeada, automaticamente fechará a issue correspondente. Legal, né?

Na verdade há uma série de palavras chaves que fazem isso:

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • Resolved

Para mais informações de como brincar com isso, basta acessar este link.

Dica 4 – Link para trechos de códigos

Quer mostar um código (ou citá-lo) sem ter que ficar passando o link para a pessoa e então o número da linha que ela deve olhar? Simples, basta pegar o link direto do trecho específico do código que você quer mostrar. Fazendo uma analogia simples, é como no Youtube, quando você quer compartilhar um vídeo, mas a partir de um específico trecho.

Para isso, basta abrir o seu arquivo no GitHub, clicar na linha específica com o botão direito e apertar a opção “Copy permalink”.

No caso deste exemplo, o link gerado foi: https://github.com/DiegoPinho/workshop-cpmg2017/blob/5c4bfd4023d25c448e7ed51a3c3172263195752b/src/Navio.js#L11

Dica 5 – Links para comentários

Do mesmo jeito que é possível ter um link para um trecho de código específico, é possível fazer o mesmo para um comentário. O procedimento é igualmente fácil, basta clicar na hora que o comentário foi feito que o link é disponibilizado.

Ao clicar no “a day ago” a url muda para o comentário específico

Conclusão

Estas são somente algumas dicas simples, mas que nem todos tem conhecimento. O GitHub tem muitas outras ferramentas internas fantásticas, mas deixaremos elas para outros artigos.

De 0 a 10, o quanto você recomendaria este artigo para um amigo?

 

Deixe um comentário! 2

leia mais
Este projeto é oferecido pelas empresas:
Este projeto é mantido pelas empresas:
Este projeto é apoiado pelas empresas: