fga-eps-mds / 2019.2-git-breakdown

Extensão para analise de métricas 18.215.242.203:3000

Git Breakdown

O projeto Git Breakdown é uma extensão do Google Chrome para plugin do Github que busca auxiliar o usuário a definir melhor um repositório para contribuição.

Nosso software possui uma API para extrair dados do Github para analisar métricas desenvolvidas.

Acesse o site do Git Breakdown

Conheça nossa equipe

Membro	E-mail	Github	Papel	Matricula
Lucas Midlhey	[email protected]	lucasmidlhey	Scrum Master	13/0122254
Diego Resende	[email protected]	wdresende	Product Owner	15/0152183
Mateus Oliveira	[email protected]	omateusp	DevOps	16/0015006
Pedro Daia	[email protected]	pxpc2	Desenvolvedor	18/0067265
Pedro Daniel	[email protected]	pdaniel37	Desenvolvedor	16/0038090
Victor Hugo	[email protected]	wdvictor	Desenvolvedor	17/0063844
Paulo Gontijo	[email protected]	paulohgontijoo	Desenvolvedor	15/0143800
João Victor	[email protected]	jbisinotti	Desenvolvedor	17/0069991

Conheça nossa documentação

• Git Breakdown

---

Como Contribuir

1. Orientações

• Se você for um colaborador externo, dê um fork no projeto.

• A criação de issues deve seguir a política de issues.

• A criação de branches deve seguir a política de branches.

• No desenvolvimento, usar nossa política de commits.

• Pull requests só serão aceitos se estiverem passando na integração.

2. Política de Branches deste repositorio.

Master

A master será nossa branch de produção, ou seja, nela estará a versão estável do projeto. E por questões de segurança ela será bloqueada para commits e push.A interação com a master vai se dá através da de Pull requests que virão das branch de documentos.

Branches de documentos

As branches de documentos são criadas a partir da master, e serve para criação ou refatoração de documentos seguindo a issue do mesmo. No final essa branch deve ser enviada para a master, através de um pull request.

2019.2-git-breakdown's Issues

Criar o TAP

Documento de abertura de Projeto propiciando uma visão inicial do mesmo. Neste documento também são descritos as principais informações do projeto, como os pontos mais importantes elencados pela equipe de gerência e também os stakeholders do projeto.

Criar ambiente de desenvolvimento com Docker

Todos os integrantes do grupo devem ter o ambiente definido com docker e docker-compose em suas máquinas para o desenvolvimento do projeto.

• Instalar docker e docker-compose
• configurar tecnologia com o docker
• Dar início ao projeto

Criar Readme

Formular um Readme bem explicativo dentro do nosso repositório

• Politica de contribuição

• Ideia do software

Criar política de issues

Deve ser criado uma política para novas issues do projeto, para facilitar e organizar da melhor forma o que deve ser feito entre a equipe.

• Descrição sucinta do que é uma issue
• Como criar título de uma issue
• Como criar corpo de uma issue
• Descrever as labels

Criar Documento de Visão

Criação de um documento de visão que busca explicar o projeto de forma simples e direta, com foco para as funcionalidades e usabilidade. O corpo do documento deve possuir a seguinte estrutura:

• Introdução
• Posicionamento
• Descrições da Parte Interessada e do Usuário
• Visão Geral do Produto
• Recursos do Produto
• Restrições

Documentos para usar como base:

• https://fga-eps-mds.github.io/2019.1-Aix/projeto/2019/03/29/documento-de-visao/

US05 - Criar API Gateway

Eu como desenvolvedor, desejo cria a API Gateway para que haja a comunicação entre os microsserviços dentro do projeto.

• Estruturar API Gateway
• Conectar com os microsserviços já desenvolvidos

Criar plano de gerenciamento de riscos

Descrição

Entender os possiveis riscos no projeto e levantar, pontuando por probabilidade, impacto e uma ação para contornar o risco

• Estrutura Analítica de Riscos

• Categoria de Riscos

• Análise quantitativa dos Riscos

• Riscos Levantados

Iniciar reunião semanal 31/08

Descrição

Nesta reunião iremos trabalhar com product backlog, sprint review e sprint plaining.

Foi definido:

• 1 hora pra sprint review

• 2 horas product backlog

• 1 hora pra sprint plaining

• Sprint review

• Product backlog

• Sprint plaining

Configurar deploy contínuo

Eu como desenvolvedor, desejo obter deploy contínuo, para que o trabalho flua melhor.

• Checklist:
• Deploy à AWS
• Deploy contínuo

Ajustar requisição com token

As requisições devem ser adequadas para receber token como parametro para aumentar o limite de dados do github

• Checklist:
• Commits_api
• Issues_api
• Branchs_api
• Pullrequest_api

Definir politica de pull request

• Política de pull requests

Criar protótipo de alta fidelidade

Eu como desenvolvedor, desejo criar um protótipo de alta fidelidade, para servir como guia visual no desenvolvimento do frontend.

• Unir os protótipos de baixa fidelidade em uma versão final
• Evoluir a versão final do protótipo de baixa fidelidade para alta fidelidade

US01 - Filtrar informações de commits

Eu como desenvolvedor, desejo filtrar as informações de commits para que possa ser feita análise.

• Checklist:
• filtrar e manipular informações relevantes de commits
• Retornar json com informações relevantes
• Testes unitários

criar Backlog do produto

O Product Backlog é uma lista contendo todas as funcionalidades desejadas para um produto. O conteúdo desta lista é definido pelo Product Owner.

Definir política de commits

O que, onde e quando as coisas devem estar

• Política de commits

Criar pagina de login da extensão

A extensão deve ser capaz de fazer login no github e receber a token de usuário.

Esquematizar versão inicial do pipeline de desenvolvimento

Diagramar o "caminho" do código desde a concepção da ideia até a sua entrega ao usuário

Criar uma apresentação

Issue para definir quem apresenta, assim como o que será falado

• Checklist:
• Gif codigo
• slides com prototipo de alta fidelidade
• montar apresentação

exclusivamente essa issue tem que estar pronta ate terça

Criar um plano de comunicação e valida-la com a equipe

O plano de comunicação deve ser criado e validar com o restante da equipe

• Definir diretrizes de comunicação

• Definir gerencia de reunioes

• Cronograma de reuniões

Visualizar graficos em qualquer repositorio aberto

eu como usuário desejo utilizar o gitbreakdown em qualquer repositório, para que eu possa analisar diferentes repositórios

• Checklist:
• capturar a url da página
• filtrar a url

US03 - Coletar informações de branches

Eu como desenvolvedor, desejo coletar informações de branches criadas e fechadas, para que seja feita uma analise de atividade do repositório.

• Criar uma API (microsserviço)
• Fazer requisições na API do GitHub
• Usar parâmetros no endpoint
• Testes Unitários

Criar Github Pages

Criar github pages para exposição dos documentos

Iniciar primeiros treinamentos

Realizar primeiro treinamento, para o time de desenvolvimento, com os seguintes tópicos:

• Metodologia ágil, focada em scrum

• Fluxo de trabalho usando github

Criar aba do Git Breakdown dentro do GitHub

Eu como usuário, desejo visualizar o BreakDown nativamente com o GitHub , para analisar o projeto sem sair do GitHub.

• Checklist:
• Reconhecer quando o navegador está no github
• Reconhecer quando o usuário navega por um repositório

Criar EAP

criar Estrutura Analítica do Projeto que é uma diagramação com base na estrutura do projeto

US02 - Filtrar informações de issues

Eu como desenvolvedor, desejo filtrar as informações de issues para que possa ser feita a analise de issues abertas e fechadas.

Filtrar informações de Pull Request

Eu como desenvolvedor, desejo filtrar as informações de PR para que possa ser feita analise de PR's

Checklist:

• Filtrar PR's

• Retornar json com número de abertos e fechados e a porcentagem de recusados em relação aos fechados

• Testes unitários

Fazer teste de integração na API Gateway

Eu como Desenvolvedor, desejo fazer testes de integração entre a API Gateway e os microsserciços, para aumentar a cobertura de testes.

• Checklist:
• testar o microsserviço de commits
• testar o microsserviço de issues
• testar o microsserviço de pullrequests
• testar o microsserviço de branches

criar plano de gerenciamento do projeto

Descrição

Este documento tem o objetivo de esclarecer os trabalhos de gerenciamento ágeis adotadas para o projeto e todas suas etapas

• O ciclo de vida do projeto e os processos que serão aplicados em cada fase;

• Como o trabalho será executado para completar os objetivos do projeto;

• O que será feito para manter a integridade das linhas de base do projeto;

• Quais as necessidades para as comunicações entre as partes interessadas.

Visualizar gráfico de commits

Eu como desenvolvedor, desejo visualizar as informações de commit com grafico para que possa ser feita a analise da quantidade de commits por pessoa.

Checklist:

• Coletar commit

• analisar quantidade de commits por pessoa

• visualizar grafico

Criar identidade Visual

Deve criar uma identidade visual com:

• Imagem

• Tela no github-pages

Treinar conhecimentos sobre a api do GitHub

Cada integrante de mds deve tentar coletar as informações de repositórios para treinamento de acordo com a tecnologia escolhida para o desenvolvimento.

Todo integrante deve criar uma branch e trabalhar em um método de coleta de dados do GitHub

• Victor Hugo
• Paulo Henrique
• Pedro Daia
• João Victor
• Pedro Daniel

Revisar documento de visão

Eu como desenvolvedor, desejo revisar o documento de visão, para alinhar o documento com a ideia do projeto.

• Tópicos:

• Introdução

• Posicionamento

• Descrições da Parte Interessada e do Usuário

• Visão Geral do Produto

• Recursos do Produto

• Restrições

• Bugs:

• Subtítulos em H3

Coletar informações de issues

Eu, como desenvolvedor, desejo coletar informações de issues na API do GitHub, para realizar as manipulações e formulações da métrica relacionada.

• Criar uma API (microsserviço)
• Fazer requisições na API do GitHub
• Usar parâmetros no endpoint
• Testes Unitários

US06 - Criar funcionalidade de logout da extensão

Eu como desenvolvedor, desejo criar o logout da extensão para que o token possa ser removido do cache

• Criar um botão de logout
• Confirmar remoção do token

Elaborar Roadmap de papéis

Definir roadmap para PO, Scrum Master e Devops para alinhar os stakeholders.

• analisar brainstorm de ideias

• organizar seguindo a hierarquia das funcionalidades

• validar com equipe

Revisar documento de arquitetura

Eu como desenvolvedor, desejo revisar o documento de arquitetura, para alinhar o documento com a ideia do projeto e adicionar novas decisões arquiteturais tomadas pela equipe.

• Tópicos:

• Introdução

• Representação da Arquitetura

• Metas e Restrições da Arquitetura

• Visão Lógica

• Visão de Implementação

• Novas Adições:

• API Gateway e Microsserviços

• Visão Geral da Arquitetura

• Casos de Uso

• Bugs/Aprimoramentos:

• Diagrama de Pacotes

Criar GQM

Documento de muita importância para as sprints iniciais para definir e priorizar as métricas a serem feitas

Realizar reunião semanal 07/09

Descrição

Nesta reunião iremos trabalhar com product backlog, sprint review e sprint plaining.

Foi definido:

• 1 hora pra sprint review

• 2 horas product backlog

• 1 hora pra sprint plaining

• Sprint review

• Product backlog

• Sprint plaining

Criar Orçamento do Projeto

É preciso criar um documento que detalhe os custos relacionados ao projeto levando em consideração os recursos humanos, equipamentos e os riscos.

Tópicos do documento:

• Descrição do custo de recursos humanos
• Equipamentos
• Total

Botão para página do github com icone atualizando por click

Eu como usuário, desejo visualizar o git Breakdown na página do repositório, para acessar a extensão.

• Checklist:
• botao na pagina
• manter botao quando atualiza pagina
• manter botao quando clica em outra açao da pagina

Alertar logout da extensão

Eu como Usuário, desejo ser avisado quando sair da minha conta, para nao passar despercebido minha saida.

• Checklist:
• mensagem de alerta
• fechar mensagem

Coletar informações de commits

Receber informações de commits do repositório a partir da API do github.

Criar protótipo de baixa fidelidade

Cada integrante de MDS deverá produzir um protótipo de baixa fidelidade.

• Pedro Daniel
• Victor Antunes
• Paulo Henrique
• Pedro Daia
• João Victor

Criar Documento de Arquitetura

Planejar e desenvolver o documento de arquitetura.

Este documento deve ter:

• Introdução
• Representação de Arquitetura
• Metas e Restrições da Arquitetura
• Visão de Casos de Uso
• Visão Lógica

Documentos para usar como base:

• https://fga-eps-mds.github.io/2019.1-Aix/projeto/2019/03/29/documento-de-arquitetura/

US04 - Coletar informações de PR

Eu, como desenvolvedor, desejo coletar informações de Pull Requests enviadas e aceitas, para que seja feita uma analise de features aceitas.

• Criar uma API (microsserviço)
• Fazer requisições na API do GitHub
• Usar parâmetros no endpoint
• Testes Unitários

Definir política de branches

O que, onde e quando as coisas devem estar

• Política de branches

Definir perfil da comunidade do repositório

Eu como desenvolvedor, desejo definir perfil da comunidade do repositório, para ajustar o repositório de acordo com os padrões da comunidade.

• Checklist:
• Code of conduct
• Contributing
• License
• Issue templates
• Pull request template

filtrar informações de branch

Eu como desenvolvedor, desejo filtrar as informações de branch para que possa ser feita a análise de branches ativas e a porcentagem de branches mescladas merged)

Checklist:

• Filtrar branches ativas
• Filtrar branches mescladas
• Porcentagem de branches mescladas
• Testes unitários

Visualizar gráfico de issues

Eu como usuário, desejo visualizar gráficos de issues, para controlar e visualizar.

• Checklist:
• Visualizar gráfico
• Coletar issues
• Controlar com JS