Skip to content

vitor-terra/exploring-code-evolution

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Explorando evolução de código

Neste exercício, iremos explorar a evolução de código em sistemas reais.

Iremos utilizar a ferramenta GitEvo. Essa ferramenta analisa a evolução de código em repositórios Git nas linguagens Python, JavaScript, TypeScript e Java, e gera relatórios HTML como este.

Mais exemplos de relatórios podem ser podem ser encontrados em https://github.com/andrehora/gitevo-examples.

Passo 1: Selecionar repositório a ser analisado

Selecione um repositório relevante na linguagem de sua preferência (Python, JavaScript, TypeScript ou Java). Você pode encontrar projetos interessantes nos links abaixo:

Passo 2: Instalar e rodar a ferramenta GitEvo

Note

Antes de instalar a ferramenta, é recomendado criar e ativar um ambiente virtual Python.

Instale a ferramenta GitEvo com o comando:

$ pip install gitevo

Execute a ferramenta no repositório selecionado utilizando o comando abaixo (ajuste conforme a linguagem do repositório). Substitua <git_url> pela URL do repositório que será analisado:

# Python
$ gitevo -r python <git_url>

# JavaScript
$ gitevo -r javascript <git_url>

# TypeScript
$ gitevo -r typescript <git_url>

# Java
$ gitevo -r java <git_url>

Por exemplo, para analisar o projeto Flask escrito em Python:

$ gitevo -r python https://github.com/pallets/flask

Note

Essa etapa pode demorar alguns minutos pois o projeto será clonado e analisado localmente.

Passo 3: Explorar o relatório de evolução de código

Após executar a ferramenta GitEvo, é gerado um relatório HTML contendo diversos gráficos sobre a evolução do código.

Abra o relatório HTML e observe com atenção os gráficos.

Passo 4: Explicar um gráfico de evolução de código

Selecione um dos gráficos de evolução e explique-o com suas palavras. Por exemplo, você pode:

  • Detalhar a evolução ao longo do tempo
  • Detalhar se as curvas estão de acordo com boas práticas
  • Explicar grandes alterações nas curvas
  • Explorar a documentação do repositório em busca de explicações para grandes alterações
  • etc.

Seja criativo!

Instruções para o exercício

  1. Crie um fork deste repositório (mais informações sobre forks aqui).
  2. Adicione o relatório HTML no seu fork.
  3. No Moodle, submeta apenas a URL do seu fork.

Responda às questões abaixo diretamente neste arquivo README.md do seu fork:

  1. Repositório selecionado: https://github.com/TheAlgorithms/Java

  2. Gráfico selecionado:

Note

O gráfico sendo analisado é o gráfico "Classes, interfaces, and records", porém o gráfico "Java files" também foi incluido para melhor ilustrar um ponto feito durante a explicação.

classes,interfaces,records

javafiles

  1. Explicação:

O gráfico selecionado é particularmente interessante pois ele mostra uma das peculiaridades do projeto, que se trata basicamente de uma coleção de algoritmos escritos em Java para fins didáticos. Enquanto em um repositório mais "clássico" se esperaria mais interfaces e records, devido à natureza do projeto, são declarados pouquíssimos desses TADs (10 interfaces e 19 records até 2025) em favor de classes comuns. Isso faz sentido, pois cada algoritmo é autocontido, raramente sendo necessários outros TADs além da classe que os contém. De fato, analisando também o gráfico de arquivos java, vemos que o repositório tem um total de 1253 arquivos Java e, voltando ao gráfico em evidência, existem 1394 classes declaradas entre estes arquivos, ou seja, apenas cerca de 1,112 classes por arquivo, ou seja, a maioria dos arquivos provavelmente contém apenas uma classe com alguns poucos contendo mais.

About

Exploring code evolution with GitEvo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%