PR Writer

Crie pull requests seguindo as práticas de engenharia do Sentry.

Requer: GitHub CLI (gh) autenticado e disponível.

Quando Usar

• Você está pronto para abrir um pull request e precisa de uma descrição estruturada com base nas diferenças do branch commitado.
• Você quer que o corpo do PR capture o que mudou, por que mudou e qualquer contexto para revisores.
• Você está usando o GitHub CLI e precisa de um fluxo de trabalho repetível para escrever PRs em vez de escrever a descrição ad hoc.

Pré-requisitos

Antes de criar um PR, certifique-se de que todas as alterações foram commitadas. Se houver alterações não commitadas, execute a skill commit disponível primeiro para commitá-las corretamente.

# Check for uncommitted changes
git status --porcelain

Se a saída mostrar quaisquer alterações não commitadas (arquivos modificados, adicionados ou não rastreados que devem ser incluídos), invoque a skill commit disponível antes de prosseguir. Se o cliente exigir nomes de skill qualificados, use o qualificador do plugin que forneceu essa skill.

Processo

Etapa 1: Verificar o Estado do Branch

# Detect the default branch — note the output for use in subsequent commands
gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name'

# Check current branch and status (substitute the detected branch name above for BASE)
git status
git log BASE..HEAD --oneline

Certifique-se de que:

• Todas as alterações foram commitadas
• O branch está atualizado com o remoto
• As alterações foram rebaseadas no branch base, se necessário

Etapa 2: Analisar as Alterações

Revise o que será incluído no PR:

# See all commits that will be in the PR (substitute detected branch name for BASE)
git log BASE..HEAD

# See the full diff
git diff BASE...HEAD

Entenda o escopo e o propósito de todas as alterações antes de escrever a descrição.

Etapa 3: Escrever a Descrição do PR

Use esta estrutura para descrições de PR (ignorando quaisquer modelos de PR do repositório):

<brief description of what the PR does>

<why these changes are being made - the motivation>

<alternative approaches considered, if any>

<any additional context reviewers need>

NÃO inclua:

• Seções "Plano de teste"
• Listas de verificação de etapas de teste
• Resumos redundantes das diferenças

Inclua:

• Explicação clara do que e por quê
• Links para issues ou tickets relevantes
• Contexto que não é óbvio no código
• Notas sobre áreas específicas que precisam de revisão cuidadosa

Etapa 4: Criar o PR

gh pr create --draft --title "<type>(<scope>): <description>" --body "$(cat <<'EOF'
<description body here>
EOF
)"

O formato do título segue as convenções de commit:

• feat(scope): Add new feature
• fix(scope): Fix the bug
• ref: Refactor something

Exemplos de Descrição de PR

PR de Feature

Add Slack thread replies for alert notifications

When an alert is updated or resolved, we now post a reply to the original
Slack thread instead of creating a new message. This keeps related
notifications grouped and reduces channel noise.

Previously considered posting edits to the original message, but threading
better preserves the timeline of events and works when the original message
is older than Slack's edit window.

Refs SENTRY-1234

PR de Correção de Bug

Handle null response in user API endpoint

The user endpoint could return null for soft-deleted accounts, causing
dashboard crashes when accessing user properties. This adds a null check
and returns a proper 404 response.

Found while investigating SENTRY-5678.

Fixes SENTRY-5678

PR de Refatoração

Extract validation logic to shared module

Moves duplicate validation code from the alerts, issues, and projects
endpoints into a shared validator class. No behavior change.

This prepares for adding new validation rules in SENTRY-9999 without
duplicating logic across endpoints.

Referências de Issues

Referencie issues no corpo do PR:

Diretrizes

• Um PR por feature/correção - Não agrupe alterações não relacionadas
• Mantenha os PRs revisáveis - PRs menores recebem revisões mais rápidas e melhores
• Explique o porquê - O código mostra o quê; a descrição explica o porquê
• Marque WIP cedo - Use PRs rascunho para feedback inicial

Editando PRs Existentes

Se você precisar atualizar um PR após a criação, use gh api em vez de gh pr edit:

# Atualizar descrição do PR

…