Configurar Code Climate para monitorar a qualidade de código do Lino

[guiaugusto]

Descrição

Para um melhor monitoramento da qualidade de código dos arquivos contidos no Lino, é necessário a configuração de uma ferramenta que seja capaz de dar um feedback mais claro a respeito da qualidade de código do repositório do Lino. Com isso, pode-se encontrar demais problemas a serem documentados e resolvidos, para uma melhor manutenibilidade de código.

Tarefas

• [x] Configurar Code Climate para o repositório.
• [x] Anexar badges de maintainability e test coverage no cabeçalho do README do repositório.

Critérios de Aceitação

• [x] Mostrar a qualidade do código atual do repositório.
• [x] Ter as badges anexadas ao README do projeto.

[aamandafelix]

Em um análise inicial do Code Climate, baseada na branch devel, o projeto foi classificado como F Os principais problemas encontrados foram:

• Duplicidade de código (códigos idênticos ou semelhantes)
• Alta complexidade cognitiva em alguns métodos

Utilizando-se de alguns plugins do Codeclimate , algumas outras questões foram apontadas, como:

• Alta complexidade ciclomática em alguns métodos
• Utilização de um método não seguro

Para mais detalhes: https://codeclimate.com/github/BotLino/Lino https://codeclimate.com/github/BotLino/Lino/pull/34

A proposta é utilizar as seguintes configurações:

• Análises de manutenabilidade realizadas por padrão
• Análises de duplicidade de código realizadas por padrão
• Análises de complexidade cognitiva realizadas por padrão
• Análises de complexidade ciclomatica utilizando o plugin radon
• Análises de segurança utilizando o plugin bandit
• Análises de estilo de código utilizando o plugin pep8

De acordo com as prioridades do projeto, é interessante retirar algumas dessas análises citadas ou até acrescentar alguma outra?

Lista de plugins disponíveis: https://docs.codeclimate.com/docs/list-of-engines

[guiaugusto]

Gostei muito de suas propostas para uma melhora na análise do Bot, principalmente do uso dos plugins que auxiliam na melhor visualização da qualidade.

Como você deu uma proposta em relação aos problemas que estamos tendo com o Lino, incrementa muito mais na contribuição sua com o Lino. Apoio a utilização de todas as citadas e não vejo a necessidade de outra, por hora.

Nesta issue mesmo, com o estado dela, a ideia final seria colocar as badges solicitadas acima no README do projeto. Em questão ao que precisa ser melhorado, será criado posteriormente outras issues para aumentar a classificação.

[aamandafelix]

A badge de manutenabilidade foi colocada, mas como não existe suíte de testes atualmente no Lino, não há como avaliar a cobertura através do Code Climate e gerar badge de testes.

[guiaugusto]

Faz sentido... Então a issue está completa... Quando iniciarmos a construção dos testes relacionados ao Lino, incluímos uma task para adicionar no README.