<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Igor Vieira on Medium]]></title>
        <description><![CDATA[Stories by Igor Vieira on Medium]]></description>
        <link>https://medium.com/@igorfv?source=rss-760e40cdf29a------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/2*R99P_G6Xl4c5yp0dCzUlPQ.jpeg</url>
            <title>Stories by Igor Vieira on Medium</title>
            <link>https://medium.com/@igorfv?source=rss-760e40cdf29a------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Tue, 17 Nov 2026 15:40:46 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@igorfv/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Revisão de código: Boas práticas para garantir a qualidade]]></title>
            <link>https://medium.com/tech-grupozap/revis%C3%A3o-de-c%C3%B3digo-boas-pr%C3%A1ticas-para-garantir-a-qualidade-2077434cd32d?source=rss-760e40cdf29a------2</link>
            <guid isPermaLink="false">https://medium.com/p/2077434cd32d</guid>
            <category><![CDATA[pull-request]]></category>
            <category><![CDATA[clean-code]]></category>
            <category><![CDATA[github]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[code-review]]></category>
            <dc:creator><![CDATA[Igor Vieira]]></dc:creator>
            <pubDate>Thu, 29 Dec 2016 20:47:20 GMT</pubDate>
            <atom:updated>2016-12-29T20:47:20.556Z</atom:updated>
            <content:encoded><![CDATA[<blockquote>If you want your code to be easy to write, make it easy to read. <a href="https://www.amazon.com.br/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882">Robert C. Martin — Clean Code: A Handbook of Agile Software Craftsmanship</a></blockquote><p>Assim como escrever códigos, abrir um Pull Request (aka PR) faz parte do nosso dia-a-dia. E se você quer que seu código seja revisado com a devida atenção que ele merece, seus PRs precisam ser objetivos e bem estruturados.</p><p>Separei abaixo algumas coisas que temos feito aqui no VivaReal e como isso tem ajudado a termos PRs mais fáceis de serem avaliados, o que nos deixa mais ágeis para mudanças.</p><h3>Pull Request é uma maneira de documentar</h3><p>Pull Requests podem ser uma excelente documentação. Um PR bem descritivo mantém o time inteirado sobre como está o processo de desenvolvimento de uma determinada feature, serve como consulta para entender o que aconteceu e o porquê de algumas decisões.</p><p>Uma boa prática é abrir o PR logo após o primeiro commit, adicionar as labels necessárias e fazer um pequeno checklist do que precisa ser feito. Para tarefas do front end também ajuda colocar prints de como a tela ficou e, para correções de bugs, um pequeno antes e depois.</p><p>Use e abuse das labels que o GitHub fornece. Elas ajudam a identificar facilmente em que estágio está o desenvolvimento, se é uma correção de bug, se é um teste a/b, se existe dependência de algum outro sistema e por ai vai. Crie seu próprio padrão de cores para ficar mais fácil de saber o que está acontecendo só de passar o olho rapidamente pela lista de PRs abertos.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/630/1*-eIYerouvKztvSjhdxXiAQ.png" /><figcaption>Uso das tags e checklists facilitam a rápida visualização do status do PR</figcaption></figure><h3>Mencione pessoas e referencie as issues</h3><p>Não esqueça de mencionar as pessoas ou times que precisam saber sobre o pull request (cc @igorfv — O que você acha dessa solução?)</p><p>O GitHub tem uma nova feature onde você pode pedir que alguém faça um review. Adicione as pessoas que são fundamentais para o PR.</p><p>Caso seu PR esteja resolvendo uma issue, faça uma referência para ela (fixes #1234) ,(closes #1234) .</p><h3>PRs precisam ser pequenos</h3><p>Nada como um PR com mais de 2000 linhas para revisar em uma segunda-feira de manhã para estragar a semana de qualquer pessoa. Evitar esse tipo de situação é bem mais simples do que parece:</p><ul><li>Caso o sistema em que você esteja trabalhando conte com um feature toggle você pode entregar parte da solução direto pra master com a feature desligada, de bônus você evita conflitos e já valida se o que você está fazendo não vai ter algum efeito inesperado.</li><li>Caso você não tenha um sistema de feature toggle, ou se o custo de implementar dentro de um toggle for alto, abra uma feature branch e faça pequenos PRs para ela, assim você poderá fazer merge da sua feature com a master apenas quando tudo estiver terminado.</li></ul><p>Outras vantagem de trabalhar com PRs menores é poder validar e acompanhar a linha de pensamento do desenvolvedor. Fica muito mais fácil entender como uma nova feature funciona se você acompanhou todo o processo passo a passo.</p><h3>Commits contam uma história</h3><p>Um bom costume é ter commits bem descritivos, isto torna o commit melhor de ser entendido além de facilitar a revisão do código, ajuda a entender o que foi resolvido e porque foi resolvido daquela maneira.</p><p>Veja a diferença entre um commit que diz</p><pre><em>Correção bug no menu</em></pre><p>e um commit que diz</p><pre><em>Correção bug no menu que impedia que o menu abrisse<br>- Por conta de X o código que abria o menu quebrava, foi necessário fazer XYZ para resolver esse problema<br>- Menu estava abrindo por cima de Y e então foi feito […]</em></pre><p>Nada que você escreve em seu commit é perda de tempo. Ao abrir um PR em que o commit está bem escrito, o GitHub usa a primeira linha como título e o restante das linhas como descrição.</p><p>Outra coisa importante é manter seus commits limpos para que fique fácil entender o que foi feito durante o desenvolvimento. Por exemplo, quem nunca viu isso acontecer?</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/347/1*4lVtr_YC6Z0ROYjV8hngcw.png" /><figcaption>Corrigiu o erro mas não corrigiu direito</figcaption></figure><p>Você pode arrumar seus commits fazendo um squash deles através do <a href="https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History">rebase interativo</a>, agrupando assim os dois commits de correção do bug no menu que poderiam ser um só. Na hora de fazer o merge o GitHub também fornece a opção de fazer um squash de todos os commits em apenas um.</p><h3>Vou revisar um PR. E agora?</h3><p>Algo que costumo seguir é a <a href="http://blog.d3in.org/post/111338685456/maslows-pyramid-of-code-review">Pirâmide do Code Review</a>. Sendo assim, a primeira coisa que precisamos validar é se o código funciona e faz o que ele deveria fazer corretamente. Só então devemos ver se o código é elegante ou fácil de ler. Essa &quot;hierarquia&quot; de importâncias evita ruídos desnecessários e falhas de comunicação dos PRs. Por isso é importante ter testes automatizados.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/324/1*cucgCSEVmkN0t_wWP-D28g.png" /></figure><p>Não é uma boa idéia jogar a obrigação de garantir que o código funcione para quem está fazendo o review. Preferencialmente tenha esses testes rodando em algum CI. Se você estiver revisando um código, sempre cobre os testes para o que foi desenvolvido.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/706/1*_flRyzLvHyJdqUECdyAFHQ.png" /><figcaption>Códigos que não passam nos testes não podem ser mergeados</figcaption></figure><p>Como revisor também existem outros items importantes a se tomar cuidado na hora de dar seu feedback.</p><ul><li>Familiarize-se com o problema. A pessoa perdeu tempo escrevendo um bom PR, portando leia a descrição e entenda o que está sendo feito.</li><li>Não seja grosseiro. Mesmo que tudo esteja ruim, sempre existe a forma educada de falar isso. Entender o contexto ajuda muito.</li><li>Dê sugestões de alteração em vez de ordens. O que você acha? ou Você concorda? ajudam a mudar o tom.</li><li>Caso não entenda algum ponto, pergunte.</li><li>Reconheça os pontos positivos. Quando identificar algum código ou alguma técnica notável, não deixe de valorizar com elogios.</li><li>Use e abuse dos emojis. Isso pode ser um problemaserá sempre mais frio e distante que um bom Isso pode ser um problema 🤔 .</li></ul><h3>Cultura reflete na qualidade</h3><p>Desenvolvimento de software não é sobre escrever código para máquinas e sim para pessoas. Melhorar a escrita de reviews e PRs, e fazer com que isso faça parte da cultura do time tem um efeito bem maior do que apenas a melhora da qualidade geral do código, tem o poder de melhorar a integração entre as pessoas do time e a sua confiança sobre o código.</p><p>Essas práticas ajudaram muito o nosso time, principalmente em relação a qualidade do código. Porém cada time tem um processo e está em uma fase de maturidade diferente, por isso é importante entender em que ponto o time está para adotar os processos e mudanças de forma responsável e coerente.</p><h4>Referências</h4><ul><li>How to write the perfect pull request — <a href="https://github.com/blog/1943-how-to-write-the-perfect-pull-request">https://github.com/blog/1943-how-to-write-the-perfect-pull-request</a></li><li>Maslow’s pyramid of code review — <a href="http://blog.d3in.org/post/111338685456/maslows-pyramid-of-code-review">http://blog.d3in.org/post/111338685456/maslows-pyramid-of-code-review</a></li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=2077434cd32d" width="1" height="1" alt=""><hr><p><a href="https://medium.com/tech-grupozap/revis%C3%A3o-de-c%C3%B3digo-boas-pr%C3%A1ticas-para-garantir-a-qualidade-2077434cd32d">Revisão de código: Boas práticas para garantir a qualidade</a> was originally published in <a href="https://medium.com/tech-grupozap">Tech@Grupo ZAP</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
    </channel>
</rss>