8.5 Categorizando Issues de um Repositório através de Labels no GitHub

As labels no GitHub são marcadores visuais usados para categorizar issues e pull requests dentro de um repositório. Elas ajudam a organizar, priorizar e comunicar informações importantes sobre o estado ou o tipo de tarefa. (Os pull requests serão explicados mais adiante, mas é importante saber que labels também podem ser utilizadas neles.)

Para que servem as labels?

As labels servem para:

• Classificar issues e pull requests de acordo com seu propósito ou status.

• Ajudar a equipe a identificar rapidamente tarefas urgentes, bugs, melhorias, entre outros.

• Facilitar a triagem e a organização do trabalho dentro de um repositório.

Estrutura de uma label

Ao criar ou editar uma label, você precisa preencher três campos:

• Label name (Nome da label): Define o nome da label, que será exibido nas issues e pull requests.

• Description (Descrição): Opcional, mas recomendada. Explica o propósito da label para facilitar seu uso correto.

• Color (Cor): Permite escolher uma cor para a label, ajudando na diferenciação visual. As cores são definidas em formato hexadecimal (hex), um código de seis caracteres precedido por # que representa uma cor específica. Se quiser aprender mais sobre cores hexadecimais, confira este guia sobre cores hex. No GitHub, você pode definir a cor manualmente ou clicar no botão Generate a new color para que o sistema sugira uma cor aleatória.

Labels padrões do GitHub

Por padrão, o GitHub fornece algumas labels predefinidas em novos repositórios:

Labels padrões do GitHub

Label	Tradução	Descrição
bug	erro/defeito	Indica um problema ou erro no código.
duplicate	duplicado	Indica que a issue ou PR já foi relatado anteriormente.
enhancement	melhoria/novidade	Utilizada para novas funcionalidades no projeto.
good first issue	boa primeira issue	Sinaliza uma issue que é boa para novas pessoas contribuidoras.
help wanted	precisamos de ajuda	Indica que a equipe precisa de ajuda para resolver a issue.
invalid	inválida	Mostra que a issue ou PR não é válido.
question	dúvida/pergunta	Indica que a issue está relacionada a uma dúvida.
wontfix	não será corrigida	Indica que a equipe decidiu não corrigir o problema.
documentation	documentação	Usada para identificar issues e PRs relacionados à melhoria ou criação de documentação.

Essas labels podem ser editadas ou removidas conforme necessário.

Como adicionar uma label a uma issue

1. Acesse o repositório no GitHub.

2. Navegue até a aba Issues e abra a issue desejada.

3. No menu lateral direito, clique na engrenagem (⚙️) ao lado da palavra Labels.

4. Selecione uma ou mais labels na lista.

5. A label será automaticamente adicionada à issue.

Como remover uma label de uma issue

1. Acesse o repositório no GitHub.

2. Navegue até a aba Issues e abra a issue desejada.

3. No menu lateral direito, clique na engrenagem (⚙️) ao lado da palavra Labels.

4. Desmarque a label que deseja remover.

5. A label será removida imediatamente da issue.

Sua vez!

Agora que você aprendeu sobre labels, siga os passos abaixo para praticar.

1. Acesse a issue que você criou anteriormente "Adicionar imagem de saudação ao README.md" no seu repositório hello-world.

2. No menu lateral direito, clique na engrenagem ao lado da palavra Labels.

3. Selecione a label documentation (documentação).

4. Verifique se a label foi adicionada corretamente.