From eac81a5bb25a91fd504ede8ee08057c522c22bc3 Mon Sep 17 00:00:00 2001 From: thegm445 Date: Tue, 12 Dec 2023 22:21:45 -0300 Subject: [PATCH] docs(fix-and-finalize-docs): goals for each sprint have been added, as well as some new sprints --- docs/source/scrum/intro.rst | 3 +++ docs/source/scrum/sprints/sprint-0.rst | 10 ++++++++ docs/source/scrum/sprints/sprint-1.rst | 11 ++++++++- docs/source/scrum/sprints/sprint-2.rst | 8 ++++++ docs/source/scrum/sprints/sprint-3.rst | 10 ++++++++ docs/source/scrum/sprints/sprint-4.rst | 17 ++++++++++--- docs/source/scrum/sprints/sprint-5.rst | 32 ++++++++++++++++++++++++ docs/source/scrum/sprints/sprint-6.rst | 34 ++++++++++++++++++++++++++ docs/source/scrum/sprints/sprint-7.rst | 24 ++++++++++++++++++ 9 files changed, 144 insertions(+), 5 deletions(-) create mode 100644 docs/source/scrum/sprints/sprint-5.rst create mode 100644 docs/source/scrum/sprints/sprint-6.rst create mode 100644 docs/source/scrum/sprints/sprint-7.rst diff --git a/docs/source/scrum/intro.rst b/docs/source/scrum/intro.rst index 3011151..f52a2f7 100644 --- a/docs/source/scrum/intro.rst +++ b/docs/source/scrum/intro.rst @@ -24,3 +24,6 @@ Sprints sprints/sprint-2 sprints/sprint-3 sprints/sprint-4 + sprints/sprint-5 + sprints/sprint-6 + sprints/sprint-7 diff --git a/docs/source/scrum/sprints/sprint-0.rst b/docs/source/scrum/sprints/sprint-0.rst index 39b3e81..8ff6164 100644 --- a/docs/source/scrum/sprints/sprint-0.rst +++ b/docs/source/scrum/sprints/sprint-0.rst @@ -10,6 +10,16 @@ Esta sprint teve como objetivo primário criar o ambiente inicial de desenvolvimento, a definição do tema, separação dos papéis exercidos pelos membros do grupo e a iniciação da documentação do projeto. +Missões da sprint +----------------- + +Nesta sprints precisávamos nos situar na matéria, metas a bater: +- Começar o estudo das ferramentas OK +- Decidir quem fará qual papel OK +- Definir o tema (colocar issues para prof escolher) OK +- Documentação inicial OK + + Changelog ---------- diff --git a/docs/source/scrum/sprints/sprint-1.rst b/docs/source/scrum/sprints/sprint-1.rst index dd7e567..08743ca 100644 --- a/docs/source/scrum/sprints/sprint-1.rst +++ b/docs/source/scrum/sprints/sprint-1.rst @@ -11,8 +11,17 @@ modelagem incial do projeto. O fim desta sprint era, também, ter uma estrutura para que possamos trabalhar nas partes cruciais do projeto, como as submissões e os contests. + +Missões da sprint +----------------- + +Nesta sprint as metas eram: +- Adicionar/Instalar ferramentas (tanto nos ambientes quanto no github) OK +- Dar forma à aplicação, bootstrap e outros 'cosméticos' OK +- Organizar README.md e CONTRIBUTING.md OK + Changelog ----------- +--------- - `Adicionar bootstrap inicial da aplicação (#13) `_ - `Adicionar barra de navegação ao HTML base (#14) `_ diff --git a/docs/source/scrum/sprints/sprint-2.rst b/docs/source/scrum/sprints/sprint-2.rst index 826b8c4..3a6b842 100644 --- a/docs/source/scrum/sprints/sprint-2.rst +++ b/docs/source/scrum/sprints/sprint-2.rst @@ -9,6 +9,14 @@ Resumo Esta sprint teve como objetivo finalizar e polir o projeto, visto que esta sprint antecedeu a primeira release do projeto. +Missões da sprint +----------------- + +Nesta sprint as metas eram: +- Apresentar o que fizemos até o presente momento OK +- Terminar de organizar a documentação OK +- Desenhar e desenvolver alguns itens avaliativos do plano de ensino OK + Changelog ---------- diff --git a/docs/source/scrum/sprints/sprint-3.rst b/docs/source/scrum/sprints/sprint-3.rst index 070e97e..8b5607d 100644 --- a/docs/source/scrum/sprints/sprint-3.rst +++ b/docs/source/scrum/sprints/sprint-3.rst @@ -11,6 +11,16 @@ Fase que é focada mais na implementação, portanto o objetivo desta sprint foi melhorar a aparência da página de registro de usuário e iniciar o desenvolvimento dos testes unitários (requisito presente no plano de ensino). + +Missões da sprint +----------------- + +Nesta sprint as metas eram: +- (ir bem na prova de EDA1/EDA2) +- Adicionar partes fundamentais para o funcionamento do projeto OK + + + Changelog ---------- diff --git a/docs/source/scrum/sprints/sprint-4.rst b/docs/source/scrum/sprints/sprint-4.rst index 37c6daf..36b6087 100644 --- a/docs/source/scrum/sprints/sprint-4.rst +++ b/docs/source/scrum/sprints/sprint-4.rst @@ -1,14 +1,23 @@ Sprint 4 ======== -:bdg-info:`19/11/2023` +:bdg-info:`15/11/2023` Resumo ------ -Nesta sprint, a equipe de desenvolvimento começou a trabalhar na segunda release. As -principais atividades foram o início do desenvolvimento da parte de submissões e a -estilização da página de login para melhor acessibilidade do usuário. +Nesta sprint, a equipe de desenvolvimento começou a trabalhar na segunda +release. As principais atividades foram o início do desenvolvimento da parte de +submissões e a estilização da página de login para melhor acessibilidade do +usuário. + +Missões da sprint +----------------- + +Nesta sprint as metas eram: +- Adicionar submissões (parte integrante do conceito de Juiz Virtual) OK +- Estilizar certas páginas OK +- Alterar e melhorar documentação OK Changelog diff --git a/docs/source/scrum/sprints/sprint-5.rst b/docs/source/scrum/sprints/sprint-5.rst new file mode 100644 index 0000000..5b33a31 --- /dev/null +++ b/docs/source/scrum/sprints/sprint-5.rst @@ -0,0 +1,32 @@ +Sprint 5 +======== + +:bdg-info:`21/11/2023` + +Resumo e Missões da sprint +-------------------------- +Nesta sprint o objetivo era continuar a melhorar o projeto, fazendo ele se +parecer cada vez mais com outros juízes virtuais: + +- Criando umas das partes mais fundamentais de um Juiz Virtual (as submissões) +- Criando uma página onde o usuário pode ver as informações da conta +- Adicionando LaTeX nas descrições de tasks para que fórmulas sejam renderizadas + +Todos objetivos foram cumpridos com êxito. + + +Changelog +---------- + +- `Atualizar tabela de membros da equipe (#88) `_ +- `Criar template formulário de submissão (#80) `_ +- `Adicionar fomulário inicial de submissão (#86) `_ +- `Adicionar página de perfil do usuário (#64) `_ +- `Adicionar página de perfil do usuário (PR) (#82) `_ +- `Corrigir comandos relacionados ao Docker Compose no guia de instalação (#71) `_ +- `Adicionar documentação das sprints (#85) `_ +- `Adicionar arquivos de configuração do Heroku (#87) `_ +- `Logar automaticamente ao criar uma nova conta (#78) `_ +- `Logar automaticamente ao criar uma nova conta (PR) (#81) `_ +- `Renderizar LaTeX em páginas de tasks (#79) `_ +- `Render Latex code with Katex (#84) `_ diff --git a/docs/source/scrum/sprints/sprint-6.rst b/docs/source/scrum/sprints/sprint-6.rst new file mode 100644 index 0000000..60c9ff9 --- /dev/null +++ b/docs/source/scrum/sprints/sprint-6.rst @@ -0,0 +1,34 @@ +Sprint 6 +======== + +:bdg-info:`29/11/2023` + +Resumo e Missões da sprint +-------------------------- +Nesta sprint o objetivo era terminar o core do projeto, ao julgar as submissões +de acordo com o que foi planejado (ver informações extras na página de +arquitetura do projeto, aqui, na documentação mesmo). Metas: + +- Criar página de submissões +- Integrar a fila de submissões +- Julgar as submissões +- Corrigir pequenos bugs quanto aos contests e tasks. +- Adicionar submissões no painel de administração + +Changelog +---------- + +- `Criar página de submissões (#100) `_ +- `Criar página de submissões (PR) (#101) `_ +- `Integrar sistema de fila (message broker) com a aplicação (#28) `_ +- `Adicionar integração inicial com RabbitMQ e message brokers (PR) (#102) `_ +- `Adicionar resumo da aplicação e motivação no README (#94) `_ +- `Adicionar resumo e motivação da aplicação no README (PR) (#103) `_ +- `Implement test cases feature (PR) (#98) `_ +- `Não permitir que usuário acessem tasks para contests não iniciados ou cancelados (#90) `_ +- `Não permitir que usuário acessem tasks para contests não iniciados ou cancelados (PR) (#99) `_ +- `Implementar página de outros usuários (#91) `_ +- `Implementar página de outros usuários (PR) (#97) `_ +- `Adicionar página de administração para submissões (#92) `_ +- `Adicionar página de administração para submissões (PR) (#93) `_ +- `Serve static files correctly on Heroku (PR) (#89) `_ diff --git a/docs/source/scrum/sprints/sprint-7.rst b/docs/source/scrum/sprints/sprint-7.rst new file mode 100644 index 0000000..3bdb0ea --- /dev/null +++ b/docs/source/scrum/sprints/sprint-7.rst @@ -0,0 +1,24 @@ +Sprint 7 +======== + +:bdg-info:`06/12/2023` + +Resumo e Missões da sprint +-------------------------- +Nesta sprint o objetivo era melhorar o que foi feito na sprint passada, +cumprindo as seguintes metas: + +- Melhorar a aparência do campo do código no formulário de submissão +- Adicionar pontuação para quando as submissões receberem AC quando julgadas +- Adicionar campo de restrições (afinal, o que é um Juiz Virtual sem + *1 < N < 10^6* ) + +Changelog +---------- + +- `Adicionar suporte a syntax highlighting no formulário de submissão (#95) `_ +- `Adicionar suporte a syntax highlighting no formulário de submissão (PR) (#107) `_ +- `Adicionar feature onde usuários consigam ganhar pontos (#105) `_ +- `Adicionar sistema de pontuação para usuários (#106) `_ +- `Adicionar campo de restrições da task (#96) `_ +- `Add task's constraints field (#104) `_