Políticas de Code Review

Planejamento de Code Review

Data	Versão	Descrição	Autor
24/09/2017	1.0	Criação do Documento	Pablo Diego
24/09/2017	1.1	Adição das ferramentas e Pull Requests	Pablo Diego
27/09/2017	1.2	Adição da ferramenta Coveralls	Hugo Neves de Carvalho

1. Introdução

Code Review é a examinação sistemática de códigos fonte. O objetivo desta prática é encontrar erros que foram criados durante o desenvolvimento do software, aumentando então a qualidade geral do software.

Neste documento então serão definidas as regras para revisão e análise dos códigos gerados pela equipe de desenvolvimento deste projeto.

2. Análises

Alterações realizadas no código com o objetivo de revisão e melhoria deverão ser feitas de acordo com os planos de Gerênciamento de Configuração de Software e de Qualidade. Uma análise e refatoramento do código deve então se basear nas análises de métricas obtidas através do Landscape, CodeClimate e Coveralls, e também no Documento de Arquitetura se caso algum código desenvolvido esteja ferindo a arquitetura definida.

2.1 Landscape

Esta ferramenta utiliza um conceito de Code Health para avaliar a "saúde" do código de acordo com a adequação em relação a folha de estilo, Code Smells(Possíveis causadores de bugs) e erros. Este indicador de Code Health deverá ser utilizado para revisar problemas relacionados a técnicas de programação e manutenibilidade geral do código caso a saúde caia abaixo de 70%.

2.2 CodeClimate

O CodeClimate fornece um indicador chamado GPA. Uma classificação de A a F para os arquivos do projeto em uma determinada branch, onde cada classificação recebe um valor e o projeto recebe uma média das classificações de acordo com a tabela abaixo.

Performance	Grade	Valor Numérico
Excelente	A	4.0
Bom	B	3.0
Médio	C	2.0
Ruim	D	1.0
Falhando	F	0.0

Este valor deverá ser utilizado como base para revisões de Complexidade Ciclomática, Duplicação de código, Compatibilidade, Claridade e Risco de bugs.

2.3 Coveralls

Esta ferramenta fornece um valor correspondente a porcentagem de cobertura de código pelos testes até o momento da execução da coleta. Este indicador de cobertura tem como base o valor de 30%, ou seja, a cobertura mínima aceita é 30%.

2.4 Pull Requests

Para aceitação de um Pull request o processo de revisão deverá seguir as definições feitas acima também, sendo estas resumidamente:

• CodeClimate GPA: >= 3.0
• Landscape Health: >= 70%
• Coveralls Coverage: >= 30%
• Travis Build: Passing.