|
| 1 | +--- |
| 2 | +title: Revisando pull requests |
| 3 | +content_type: concept |
| 4 | +main_menu: true |
| 5 | +weight: 10 |
| 6 | +--- |
| 7 | + |
| 8 | +<!-- overview --> |
| 9 | + |
| 10 | +Qualquer pessoa pode revisar um _pull request_ da documentação. |
| 11 | +Visite a seção [pull requests](https://github.com/kubernetes/website/pulls) no repositório do site Kubernetes para ver os _pull requests_ abertos. |
| 12 | + |
| 13 | +Revisar os _pull requests_ da documentação é uma ótima maneira de se apresentar à comunidade Kubernetes. |
| 14 | +Isso ajuda você a aprender a base de código e construir a confiança com outros colaboradores. |
| 15 | + |
| 16 | +Antes de revisar, é uma boa ideia: |
| 17 | + |
| 18 | +- Ler o [guia de conteúdo](/docs/contribute/style/content-guide/) e o [guia de estilo](/docs/contribute/style/style-guide/) para que você possa deixar comentários esclarecedores. |
| 19 | +- Entender as diferentes [funções e responsabilidades](/docs/contribute/participate/roles-and-responsibilities/) na comunidade da documentação do Kubernetes. |
| 20 | + |
| 21 | +<!-- body --> |
| 22 | + |
| 23 | +## Antes de começar |
| 24 | + |
| 25 | +Antes de começar uma revisão: |
| 26 | + |
| 27 | +- Leia o [Código de Conduta da CNCF](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) e certifique-se de cumpri-lo o tempo todo. |
| 28 | +- Seja educado, atencioso e prestativo. |
| 29 | +- Comente os aspectos positivos dos PRs, bem como mudanças. |
| 30 | +- Seja empático e cuidadoso, observe como sua avaliação pode ser recebida. |
| 31 | +- Assuma boas intenções e faça perguntas esclarecedoras. |
| 32 | +- Colaboradores experientes, considere trabalhar em par com os novos colaboradores cujo trabalho requer grandes mudanças. |
| 33 | + |
| 34 | +## Processo de revisão |
| 35 | + |
| 36 | +Em geral, revise os _pull requests_ de conteúdo e estilo em inglês. |
| 37 | +A Figura 1 descreve as etapas para o processo de revisão. |
| 38 | +Seguem os detalhes para cada etapa. |
| 39 | + |
| 40 | +<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure --> |
| 41 | +<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it --> |
| 42 | + |
| 43 | +{{< mermaid >}} |
| 44 | +flowchart LR |
| 45 | + subgraph fourth[Começar revisão] |
| 46 | + direction TB |
| 47 | + S[ ] -.- |
| 48 | + M[adicionar comentários] --> N[revisar mudanças] |
| 49 | + N --> O[novos colaboradores devem<br>escolher Comment] |
| 50 | + end |
| 51 | + subgraph third[Selecionar PR] |
| 52 | + direction TB |
| 53 | + T[ ] -.- |
| 54 | + J[leia a descrição<br>e comentários]--> K[visualize as mudanças no ambiente<br>de pré-visualização do Netlify] |
| 55 | + end |
| 56 | + |
| 57 | + A[Revise a lista de PR abertos]--> B[Filtre os PRs abertos<br>pela label] |
| 58 | + B --> third --> fourth |
| 59 | + |
| 60 | + |
| 61 | +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; |
| 62 | +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold |
| 63 | +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 |
| 64 | +class A,B,J,K,M,N,O grey |
| 65 | +class S,T spacewhite |
| 66 | +class third,fourth white |
| 67 | +{{</ mermaid >}} |
| 68 | + |
| 69 | +Figura 1. Etapas do processo de revisão. |
| 70 | + |
| 71 | +1. Acesse [https://github.com/kubernetes/website/pulls](https://github.com/kubernetes/website/pulls). |
| 72 | + Você verá uma lista de todas as solicitações de _pull requests_ abertos no site e na documentação do Kubernetes. |
| 73 | + |
| 74 | +2. Filtre os PRs abertos usando um ou todos os _labels_ seguintes: |
| 75 | + |
| 76 | + - `cncf-cla: yes` (Recomendado): PRs enviados por colaboradores que não assinaram o CLA não podem ser feito o _merge_. Consulte [Assinar o CLA](/docs/contribute/new-content/#sign-the-cla) para obter mais informações. |
| 77 | + - `language/pt` (Recomendado): Filtro para PRs em português. |
| 78 | + - `size/<size>`: Filtro para PRs com um determinado tamanho. Se você é novo, comece com PRs menores. |
| 79 | + |
| 80 | + Além disso, certifique-se que o PR não esteja marcado como `work in progress`. Os PRs que usam o _label_ `work in progress` ainda não estão prontos para revisão. |
| 81 | + |
| 82 | +3. Depois de selecionar um PR para revisar, entenda a mudança: |
| 83 | + |
| 84 | + - Lendo a descrição do PR para entender as alterações feitas e ler quaisquer `issues` vinculadas |
| 85 | + - Lendo quaisquer comentários de outros revisores |
| 86 | + - Clicando na aba **Files changed** para ver os arquivos e linhas alteradas |
| 87 | + - Pré-visualizar as alterações ambiente de pré-visualização do _Netlify_, rolando até a seção _PR's build check_ na parte inferior da aba **Conversation**. |
| 88 | + Aqui está uma captura da tela (isso mostra a área de trabalho do site GitHub; se você estiver revisando em um tablet ou smartphone, a interface web do usuário GitHub será um pouco diferente): |
| 89 | + {{< figure src="/images/docs/github_netlify_deploy_preview.png" alt="Detalhes do PR no GitHub, incluindo o link para a visualização do Netlify" >}} |
| 90 | + Para abrir a visualização, selecione o link **Details** da linha **deploy/netlify** na lista de verificações. |
| 91 | + |
| 92 | +4. Vá para a aba **Files changed** para iniciar sua revisão. |
| 93 | + |
| 94 | + 1. Clique no símbolo `+` ao lado da linha que você deseja comentar. |
| 95 | + |
| 96 | + 1. Preencha com todos os comentários que você tenha sobre a linha e clique em **Add single comment** (se você tiver apenas um comentário para fazer) ou **Start a review** (se você tiver vários comentários para fazer) |
| 97 | + |
| 98 | + 1. Quando terminar, clique em **Review changes** na parte superior da página. |
| 99 | + Aqui, você pode adicionar um resumo da sua revisão (e deixar alguns comentários positivos para o colaborador!). |
| 100 | + Por favor, sempre use o "Comentário" |
| 101 | + |
| 102 | + - Evite clicar no botão "Request changes" ao concluir sua revisão. |
| 103 | + Se você quiser bloquear o _merge_ do PR antes que outras alterações sejam realizadas, você pode deixar um comentário "/hold". |
| 104 | + Mencione por que você está definindo o bloqueio e, opcionalmente, especifique as condições sob as quais o bloqueio pode ser removido por você ou por outros revisores. |
| 105 | + |
| 106 | + - Evite clicar no botão "Approve" ao concluir sua revisão. |
| 107 | + Deixar um comentário "/approve" é recomendado na maioria dos casos. |
| 108 | + |
| 109 | + |
| 110 | +## Checklist para revisão |
| 111 | + |
| 112 | +Ao revisar, use como ponto de partida o seguinte. |
| 113 | + |
| 114 | +### Linguagem e gramática |
| 115 | + |
| 116 | +- Existe algum erro óbvio na linguagem ou gramática? Existe uma maneira melhor de expressar algo? |
| 117 | + - Concentre-se na linguagem e na gramática nas partes que o autor está mudando na página. |
| 118 | + A menos que o autor esteja claramente com o objetivo de atualizar a página inteira, ele não tem obrigação de corrigir todos os problemas na página. |
| 119 | + - Quando um PR atualiza uma página existente, você deve se concentrar em revisar as partes que estão sendo atualizadas na página. |
| 120 | + Esse conteúdo alterado deve ser revisado quanto à correção técnica e editorial. |
| 121 | + Se você encontrar erros na página que não se relacionam diretamente com o que o autor do PR está tentando resolver, ele deve ser tratado em uma `issue` separada (primeiro, verifique se não existe uma `issue` existente sobre isso). |
| 122 | + - Cuidado com os _pull requests_ que movem conteúdo. |
| 123 | + Se um autor renomear uma página ou combinar duas páginas, nós (_Kubernetes SIG Docs_) geralmente evitamos pedir a esse autor que corrija todas as questões gramaticais ou ortográficas que poderíamos identificar dentro desse conteúdo movido. |
| 124 | +- Existem palavras complicadas ou arcaicas que podem ser substituídas por uma palavra mais simples? |
| 125 | +- Existem palavras, termos ou frases em uso que podem ser substituídos por uma alternativa não discriminatória? |
| 126 | +- A escolha da palavra e sua capitalização seguem o [guia de estilo](/docs/contribute/style/style-guide/)? |
| 127 | +- Existem frases longas que podem ser mais curtas ou menos complexas? |
| 128 | +- Existem parágrafos longos que podem funcionar melhor como uma lista ou tabela? |
| 129 | + |
| 130 | +### Conteúdo |
| 131 | + |
| 132 | +- Existe conteúdo semelhante em outro lugar no site Kubernetes? |
| 133 | +- O conteúdo está excessivamente vinculado a uma documentação externa, de um fornecedor individual ou de um código não aberto? |
| 134 | + |
| 135 | +### Website |
| 136 | + |
| 137 | +- Esse PR alterou ou removeu um título da página, _slug/alias_ ou link? |
| 138 | +Em caso afirmativo, existem links quebrados como resultado deste PR? |
| 139 | +Existe outra opção, como alterar o título da página sem alterar o _slug_? |
| 140 | +- O PR apresenta uma nova página? Caso afirmativo: |
| 141 | + - A página está usando corretamente o [tipo de conteúdo](/docs/contribute/style/page-content-types/) e os códigos relacionados ao Hugo? |
| 142 | + - A página aparece corretamente na navegação da seção (ou em geral)? |
| 143 | + - A página deve aparecer na lista em [Documentação/Home](/pt-br/docs/home/)? |
| 144 | +- As alterações aparecem na visualização do Netlify? Esteja particularmente atento a listas, blocos de código, tabelas, notas e imagens. |
| 145 | + |
| 146 | +### Outro |
| 147 | + |
| 148 | +- Cuidado com as [edições triviais](https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits); |
| 149 | + se você observar uma mudança que entender ser uma edição trivial, por favor, marque essa política (ainda não há problema em aceitar a alteração se for genuinamente uma melhoria). |
| 150 | +- Incentive os autores que estão fazendo correções de espaço em branco a fazê-lo no primeiro commit de seu PR e, em seguida, adicione outras alterações além disso. |
| 151 | + Isso facilita as revisões e o _merge_. |
| 152 | + Cuidado especialmente com uma mudança trivial que aconteça em um único _commit_, juntamente com uma grande quantidade de limpeza dos espaços em branco (e se você observar isso, incentive o autor a corrigi-lo). |
| 153 | + |
| 154 | +Como revisor, se você identificar pequenos problemas com um PR que não são essenciais para o significado, como erros de digitação ou espaços em branco incorretos, sinalize seus comentários com `nit:`. |
| 155 | +Isso permite que o autor saiba que esta parte do seu _feedback_ não é uma crítica. |
| 156 | + |
| 157 | +Se você estiver considerando um __pull request__ e todo o _feedback_ restante estiver marcado como um `nit`, você pode realizar o _merge_ do PR de qualquer maneira. |
| 158 | +Nesse caso, muitas vezes é útil abrir uma _issue_ sobre os `nits` restantes. |
| 159 | +Considere se você é capaz de atender aos requisitos para marcar esse nova _issue_ como uma [Good First Issue](https://www.kubernetes.dev/docs/guide/help-wanted/#good-first-issue); se você puder, esses são uma boa fonte. |
0 commit comments