Carregando
0x30Lição 4 de 14

Issues, labels e projetos

Relate bugs e planeje o trabalho com issues, labels, milestones e templates, feche-as a partir de pull requests e acompanhe tudo em quadros de projeto.

24 min Questionário com 7 perguntas 2 exercícios de código
Ao final desta lição, você saberá
  • Escrever uma issue útil e organizar issues com labels, responsáveis e milestones
  • Fechar issues automaticamente a partir de pull requests com palavras-chave de fechamento
  • Planejar o trabalho num quadro do GitHub Projects e saber quando usar Discussions

Uma issue é uma unidade de trabalho ou de conversa: um bug, uma ideia de funcionalidade, uma pergunta, uma tarefa de manutenção. O Dungeon Dash tem algumas centenas delas, e é com elas que a equipe decide o que fazer em seguida.

Um bom relato de bug poupa horas de todo mundo. Ele tem:

  1. um título específico (“Herói atravessa paredes depois de um dash”, e não “bug!!”),
  2. passos para reproduzir,
  3. o que você esperava e o que aconteceu em vez disso,
  4. versões e ambiente (versão do jogo, sistema operacional),
  5. capturas de tela, logs ou um exemplo mínimo.

Os mantenedores facilitam isso com templates de issue (arquivos em .github/ISSUE_TEMPLATE/) que preenchem essas seções de antemão, ou com formulários de issue que as transformam num formulário com campos obrigatórios.

Depois, organize:

FerramentaUse para
Labelstipo e área: bug, enhancement, docs, good first issue, area: audio
Responsáveis (assignees)quem está trabalhando nela (evita duas pessoas corrigindo o mesmo bug)
Milestonesagrupar issues para uma release, como v1.5, com uma barra de progresso
Tipos de issue e sub-issuesdividir um épico em partes menores
Projectsquadros e tabelas que cobrem issues e PRs, com campos personalizados como status, prioridade e iteração

Nem tudo é uma issue. Perguntas e ideias em aberto cabem melhor em Discussions, um fórum embutido no repositório - deixando a lista de issues para o trabalho acionável.

Fechando issues a partir de pull requests

Quando um pull request corrige uma issue, diga isso com uma palavra-chave de fechamento na descrição dele: close, closes, closed, fix, fixes, fixed, resolve, resolves ou resolved, seguida de uma referência à issue. Quando o PR é mesclado na branch padrão, o GitHub fecha a issue e liga as duas para sempre.

Fixes #42
Resolves dungeon-dash/level-editor#7

Cada issue precisa da sua própria palavra-chave: Fixes #42, #43 fecha só a #42. Escreva Fixes #42, fixes #43. Menções simples como “see #44” criam um link sem fechar.

closing_keywords.py
1import re
2
3KEYWORD = re.compile(r"\b(?:close[sd]?|fix(?:e[sd])?|resolve[sd]?):?\s+((?:[\w.-]+/[\w.-]+)?#\d+)", re.IGNORECASE)
4
5description = """Boss battle polish.
6Fixes #42, #43 and resolves #57.
7Also see #60. Closes dungeon-dash/level-editor#7"""
8print(KEYWORD.findall(description))
Saída
['#42', '#57', 'dungeon-dash/level-editor#7']

Experimente

Até 15 XP

Issue, discussion ou pull request?

Onde cada um destes itens fica no repositório do Dungeon Dash?

0 de 6 classificadosPontuação 0/0
  • ““O herói cai através do chão na fase 3”, com passos para reproduzir”

  • ““O que vocês acham de um modo multijogador algum dia?””

  • “Uma correção para o bug de cair através do chão”

  • ““Como eu instalo o jogo no Linux?””

  • “Tarefa: atualizar as capturas de tela do README para a v1.5”

  • “Uma fase nova, com o arquivo da fase e o teste dela”

Principais conclusões

  • Boas issues têm um título claro, passos para reproduzir, comportamento esperado vs. real e detalhes do ambiente.

  • Labels, responsáveis e milestones organizam as issues; os Projects planejam o trabalho entre elas.

  • Palavras-chave de fechamento (fixes, closes, resolves...) num PR fecham a issue no merge - uma palavra-chave por issue.

  • Use Discussions para perguntas e ideias em aberto, e issues para trabalho acionável.

Quiz da aula

7 perguntas · aprovação com 5 acertos · até 50 XP

Ao passar, você conclui a aula e mantém sua sequência. As perguntas erradas voltarão em sessões de revisão.

Pratique: automatize tarefas do GitHub com Python

O trabalho real no GitHub envolve muita automação pequena: conferir CODEOWNERS, expandir matrizes de build, atualizar versões, ler a API. Escreva esses utilitários em Python e execute-os com entradas de exemplo, localmente no navegador e sem precisar de conta no GitHub.

Exercício 1

Que issues vão fechar?

+25 XP

Cada linha de entrada é a descrição de um pull request (numa linha só). Imprima as issues que ele vai fechar quando for mesclado, como PR 1: #42, #57 (em ordem, sem duplicatas), ou PR 1: none. Uma palavra-chave de fechamento - close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved, em maiúsculas ou minúsculas, opcionalmente seguida de dois-pontos - precisa vir logo antes de cada referência. As referências são #N ou owner/repo#N.

  • Quatro PRs
main.py
Carregando editor…

O Python é executado em um ambiente isolado no navegador, com limite de 60 segundos. O runtime é carregado pelo CDN do Pyodide; seu código permanece neste navegador.

Exercício 2

Monte o quadro de triagem

+25 XP

Cada linha de entrada é uma issue em JSON: {"number": 42, "title": ..., "state": "open"|"closed", "labels": [...], "assignee": "mira"|null}. Distribua-as nas colunas do quadro e imprima cada coluna com as suas issues (por número) como Todo: #12 #57:

  • Done: issues fechadas
  • In progress: issues abertas com responsável
  • Needs triage: issues abertas, sem responsável e sem labels
  • Todo: todas as outras issues abertas

Imprima as colunas na ordem Needs triage, Todo, In progress, Done; imprima - para uma coluna vazia. Por fim, imprima good first issues: #... - issues abertas, sem responsável e com a label good first issue - ou good first issues: none.

  • Uma semana de issues
  • Tudo concluído
main.py
Carregando editor…

O Python é executado em um ambiente isolado no navegador, com limite de 60 segundos. O runtime é carregado pelo CDN do Pyodide; seu código permanece neste navegador.

Dúvidas sobre esta lição

Travou em algum ponto? Pergunte. Descobriu algo? Compartilhe. Explicar também é uma ótima forma de aprender.

Carregando publicações…