Carregando
0x50Lição 6 de 14

Revisão de código

Revise pull requests com gentileza e eficácia, use sugestões e estados de revisão e direcione revisões com CODEOWNERS.

26 min Questionário com 7 perguntas 2 exercícios de código
Ao final desta lição, você saberá
  • Deixar comentários de revisão claros, gentis e acionáveis, incluindo mudanças sugeridas
  • Usar os estados de revisão - comment, approve, request changes - e revisões obrigatórias
  • Direcionar revisões automaticamente com um arquivo CODEOWNERS

O code review pega bugs, espalha conhecimento pela equipe e mantém a base de código consistente. No GitHub, você revisa na aba Files changed de um PR: clique numa linha (ou arraste por várias) para comentar e envie tudo como uma única revisão com um estado:

  • Comment - feedback sem veredito.
  • Approve - pode fazer o merge.
  • Request changes - precisa ser resolvido antes. Com proteção de branch, isso bloqueia o merge até o revisor aprovar.

Uma mudança sugerida é um comentário que contém um bloco marcado como suggestion. O autor pode aplicá-la com um clique, o que faz o commit por ele:

a review comment with a suggestion
1**nit:** this name hides what the number means.
2
3```suggestion
4MAX_DASH_DISTANCE = 3  # tiles
5```

Boas revisões tratam do código, nunca da pessoa, e deixam claro o peso de cada comentário:

  • Marque os comentários opcionais com um prefixo: nit: (detalhe), suggestion:, question:. Deixe explícitos os que bloqueiam.
  • Explique o porquê: “Isto roda uma vez por frame, então a cópia da lista vai pesar” é melhor que “não copie a lista”.
  • Pergunte em vez de acusar: “O que acontece se enemies estiver vazio?”
  • Elogie as coisas boas - isso diz às pessoas o que continuar fazendo.
  • Revise rápido. Um PR esperando revisão há três dias é um PR cujo autor já seguiu em frente.

E, como autor: não leve os comentários para o lado pessoal, responda a cada um (ou resolva-o com uma correção) e agradeça.

Experimente

Até 15 XP

Revise este pull request

O PR de um contribuidor adiciona ao Dungeon Dash um salvador de recordes. Clique em cada linha em que você comentaria e depois veja o que deixou passar.

src/scores.py (arquivo novo) (rodada 1 de 1)Sinais encontrados 0/0

Clique em todos os trechos suspeitos. São 5.

import json API_KEY = "sk_live_51HxQ..." def save_score(name, score): data = json.load(open("scores.json")) data.append({"name": name, "score": score}) data.sort(key=lambda entry: entry["score"]) print("DEBUG", data) json.dump(data, open("scores.json", "w")) def top_score(): return load()[0]

CODEOWNERS

Um arquivo CODEOWNERS (em .github/, na raiz ou em docs/) associa caminhos às pessoas ou equipes donas deles. Quando um PR mexe em arquivos correspondentes, o GitHub solicita automaticamente a revisão delas - e a proteção de branch pode exigir a aprovação de um code owner.

Cada linha é um padrão e um ou mais donos. Os padrões funcionam como no .gitignore, e a última linha que casa vence - então coloque as regras gerais primeiro e as específicas depois.

.github/CODEOWNERS
1# Default owners for everything
2*                 @dungeon-dash/maintainers
3
4# Art and audio
5*.png             @sam-sprites
6/assets/audio/    @dungeon-dash/audio
7
8# The physics engine
9/src/engine/      @mira
10
11# Docs: anyone on the docs team, plus mira for the API reference
12/docs/            @dungeon-dash/docs
13/docs/api/        @mira @dungeon-dash/docs

Principais conclusões

  • Envie revisões como Comment, Approve ou Request changes; as sugestões deixam os autores aplicarem correções com um clique.

  • Comente sobre o código, explique o porquê, marque os nits, faça perguntas e aponte o que está bom.

  • O CODEOWNERS solicita revisões automaticamente; a última linha que casa vence.

  • A proteção de branch pode exigir aprovações e revisões de code owners antes do merge.

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

Quem é dono deste arquivo?

+25 XP

A entrada é um arquivo CODEOWNERS, uma linha --- e depois caminhos de arquivos alterados (começando com /). Para cada caminho, imprima os donos da última regra que casa, ou (no owners). Depois imprima reviewers: ... - cada dono distinto de todos os arquivos, em ordem.

Casamento simplificado: um padrão terminado em / casa com tudo dentro daquela pasta; um padrão começando com / é casado a partir da raiz; nos outros casos, o padrão é casado (com fnmatch) com o nome do arquivo. Pule linhas em branco e comentários com #.

  • Dungeon Dash
  • Sem dono padrão
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

Este PR pode ser mesclado?

+25 XP

Cada linha de entrada é um evento de revisão em ordem cronológica: user STATE, em que STATE é APPROVED, CHANGES_REQUESTED ou COMMENTED. Só conta o approve ou request-changes mais recente de cada usuário (um COMMENTED posterior não muda o veredito dele). A branch exige 2 aprovações e nenhum pedido de mudanças pendente.

Imprima o veredito de cada revisor em ordem de nome (mira: APPROVED, ou sam: none para um revisor que só comentou) e depois mergeable: yes ou mergeable: no (1 of 2 approvals, changes requested by mira) - listando os motivos que se aplicarem, separados por vírgulas.

  • Aprovado depois de mudanças
  • Bloqueado
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…