Skip to content

Pull Request

Charleston edited this page Jul 5, 2017 · 3 revisions

Documentação de comentários de Pull Request

No comentário do arquivo será necessario indicar o grau de importância dele para quem desenvolveu se atentar nos mais prioritários e ter um historico de casos mais acertivo Ira seguir o seguinte modelo: Grau de importaria + Comentario

“Required”

Indica possível falha grave no código

Status: Obrigatório ser corrigido

Descricao: Possível falha de estouro de memória, nullpointer, código sem tratamento de erro e código fora do code style

Exemplo de uso:

Required Nessa linha aqui a variável não esta sendo inicializada e esta sendo acessada, pode ter nullpointer

“Suggestion”

Indica uma sugestão de melhoria de código

Status: Não é obrigatório ser alterado

Descricao: Alteração de código para melhoramento de performance, manuntencao ou melhor forma de implementação que altera uma lógica ou funcionalidade

Exemplo de uso:

Suggestion Daria pra utilizar uma classe Útil pra abstrair toda lógica de funcionalidade que esta aplicando aqui

“Doubt”

Indica uma duvida sobre um trecho do código

Status: Não é obrigatório ser alterado

Descricao: Indica uma duvida a ser sanada

Exemplo de uso:

Doubt Não entendi esse trecho do código, poderia me explicar?

“Nice to Have”

Indica uma duvida sobre um trecho do código

Status: Não é obrigatório ser alterado

Descricao: Aponta um melhoramento de código, mas que não altera a sua funcionalidade

Exemplo de uso:

Nice to Have O IF esta invertido com negação na primeira condição e depois com um bloco de uso em ELSE, da pra inverter pra melhorar a ordem de entendimento

Clone this wiki locally