Como documentar code review process em Git e GitHub
Prompt gerado automaticamente para Code review process em Git e GitHub
"Você é um engenheiro de software sênior com vasta experiência em equipes de desenvolvimento ágil. Sua tarefa é criar um **guia prático e conciso** para um novo membro da equipe (um desenvolvedor júnior) sobre como **participar efetivamente de um processo de code review no GitHub**, com foco em **melhorar a qualidade do código e a colaboração**.
O guia deve cobrir os seguintes pontos, utilizando a terminologia correta do Git/GitHub e exemplos práticos quando aplicável:
1. **Antes de abrir um Pull Request (PR):**
* O que verificar no seu próprio código (estilo, testes, funcionalidade).
* Como garantir que o histórico de commits está limpo e significativo.
* A importância da descrição do PR e como escrevê-la de forma eficaz.
2. **Durante o Code Review (como revisor):**
* A mentalidade correta para abordar um review (foco na colaboração, não na crítica).
* O que procurar em um PR (lógica, performance, segurança, legibilidade, etc.).
* Como deixar comentários construtivos e acionáveis no GitHub (exemplos de boas práticas e o que evitar).
* A importância de testar o código localmente, se necessário.
* Quando aprovar e quando solicitar alterações.
3. **Após o Code Review (como autor do PR):**
* Como interpretar e responder aos comentários de forma profissional.
* A importância de agradecer pelo feedback.
* Como fazer as alterações solicitadas (novos commits, `amend`, `rebase`).
* Quando e como solicitar uma nova revisão.
4. **Dicas Gerais para um Processo de Code Review Saudável:**
* A importância da comunicação assíncrona e síncrona.
* Como evitar bloqueios e acelerar o ciclo de feedback.
* Aprender com os reviews dos outros.
O tom deve ser didático, encorajador e profissional. O objetivo final é capacitar o desenvolvedor júnior a ser um participante ativo e valioso no processo de code review, contribuindo para um código de maior qualidade e um ambiente de equipe mais colaborativo."
Tags relacionadas
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de Git e GitHub
Continue explorando prompts nesta categoria.
Melhores práticas de branching strategies para Git e GitHub
Prompt gerado automaticamente para Branching strategies em Git e GitHub
Guia para security e permissions em Git e GitHub
Prompt gerado automaticamente para Security e permissions em Git e GitHub
Guia para version tagging em Git e GitHub
Prompt gerado automaticamente para Version tagging em Git e GitHub