1.0 - Escopo

Este documento visa demonstrar a importância da revisão de código e como faze-la em nosso ambiente de desenvolvimento.

1.1 - Porque?

A revisão de código tem se mostrato útil em nosso time, desde a sua concepção. Já constatamos várias situações onde o código liberado iria gerar certa dor de cabeça assim que posto em produção. Desta forma, é importante que as regras e conceitos previstos sejam respeitados para evitar-mos problemas.

O processo de revisão de código atua juntamente com a Política de Check-in (BC 65), afim de garantir a maior segurança possível (não a ideal) na liberação da versão. As regras propostas não estão aqui (e na política de check-in) para nos atrapalhar e tornar nosso trabalho moroso, e sim, para nos ajudar a não cometer erros, por isto é de suma importância que tudo o que é proposto seja seguido e respeitado.

1.2 - Ferramentas

O Review Assistant trabalha de forma integrada com o Visual Studio, principalmente no que diz respeito à controle de changesets. Maiores detalhes podem ser obtidos através do site oficial da ferramenta (https://www.devart.com/review-assistant/)

1.3 - Instalação

O processo de instalação é relativamente simples, com apenas uma peculiaridade, vamos aos passos:
Baixe o instalador através do site oficial (https://www.devart.com/review-assistant/) e abra o instalador. Há apenas uma peculiaridade durante a instalação, que é selecionar os componentes que devem ser instalados. Neste passo, selecione [Client Installation]:
instalacaoReviewAssistant.jpg
Prossiga até o final da instalação e conclua o processo. Após a instalação, temos que configura-lo no Visual Studio.

No Visual Studio, acesse [Tools> Review Assistante> Options] e configure os parâmetros conforme abaixo:
login.jpg
O Review Server deve ser [http://cba-tfs1:85/ReviewAssistant];
O Login é feito via Windows Authentication (domínio), logo, não é necessário informar login e senha, bastando selecionar a opção Windows Authentication e clicar em Connect.

Se configurado conforme orientação, deverá conectar normalmente. Após realizar a conexão, é necessário configurar seu "local de trabalho"', nesta mesma página vá até a aba [Projects]:
instalacaoVisualStudioProjetos.jpg

Se tudo correu conforme o plenejado, sua estação já está apta a utilizar o Review Assistant.

1.4 - Solicitando um Review de um Changeset

Para solicitar um Review, é necessário utilizar o Review Board, para insto, acesse o menu [Tools> Review Assistant> Code Review Board]. Nesta parte do processo, clique no [+] conforme orientado abaixo:
novoReview.jpg
Agora, adicione um Chengeset através do link [Add Revisions]:
adicionandoChangeset.jpg
Após selecionar o Changeset, devemos adicionar quem fará o review do changeset selecionado, para isto, adicione quantos reviewers forem necessários, veja:
adicionandoReviewers.jpg
Agora, clique em [Create] e a solicitação será criada e os envolvidos serão avisados.

1.5 - Fazendo um Review

Para fazer um Review é necessário utilizar o Review Board, para insto, acesse o menu [Tools> Review Assistant> Code Review Board]. Assim que é aberto, normalmente os reviews pendentes são exibidos, conforme imagem abaixo:
ReviewsPendentes.jpg
Neste ponto, dê dois cliques sobre o Review desejado (garanta que você é um dos reviewers escalados para a solicitação), agora, você verá esta tela:
vendoUmReview.jpg

Para analisar os arquivos e o que foi alterado em cada um deles, basta dar duplo clique em cada um dos arquivos, o Visual Studio será encarregado de abrir o comparador de código. Após analisar todos os arquivos, se tudo estiver bem, finalize a sua parte através do link [Complete Review> Accept Changes]. Caso você seja o único reviewer escalado, não esqueça de finalizar o review através do link [Complete Review> Close Review].

1.6 - Apontando um defeito no código durante a revisão

Ao se deparar com um defeito no código, que provavelmente gerará um BUG ao ser liberado para os clientes (erros menores também se encaixam neste ponto) é necessário apontar como um [Defect], onde o desenvolvedor terá que realizar a correção para então o review estar concluído. Para apontar um trecho de código com defeito, siga os seguintes passos:

Selecione o trecho de código a ser apontado como defeituoso e clique com o botão direito, em seguida, clique em [Add Review Comment]: