adicionados modelos de issues e de sprints

ResidenciaTICBrisa · Mar 6, 2024 · 1862012 · 1862012
1 parent 3798217
commit 1862012
Show file tree

Hide file tree

Showing 13 changed files with 148 additions and 13 deletions.
diff --git a/.github/ISSUE_TEMPLATE/historia_de_usuario.md b/.github/ISSUE_TEMPLATE/historia_de_usuario.md
@@ -0,0 +1,16 @@
+**Descrição**
+Eu como ***persona*** gostaria de ***realizar*** para ***alcancar um objetivo***.
+
+Exemplo: Eu como usuário gostaria de cadastrar um equipamento para registrar meu inventário.
+
+**Critérios de Aceitação** 
+- Deverá ter o campo abaixo  preenchido;
+- Deverá calcular/apresentar o valor ao produto/negócio;
+- Testável;
+
+
+**Tarefas**
+- [ ] É testável;
+- [ ] Não é um épico. 
+- [ ] É estimável.;
+- [ ] Agrega valor ao negócio;
diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md
@@ -0,0 +1,15 @@
+Uma issue deve ser criada com a finalidade de descrever:
+ - Uma tarefa do projeto;
+ - Um requisito do produto (Feature);
+ - Uma nova funcionalidade do produto;
+ - Um defeito no produto (bug, inconsistência);
+ - História de Usuário.
+
+**Descrição**
+Deve conter uma descrição detalhada explicando a finalidade para a qual à issue foi criada.
+
+**Tarefas :** 
+- [ ] Tarefa 1;
+
+***Requisitos:***
+As issues devem possuir título, descrição, no mínimo um assinante responsável, labels, milestone(a sprint que deve ser concluída) e estimated(pontuação) para as issues pontuadas.
diff --git a/.github/ISSUE_TEMPLATE/pull_request.md b/.github/ISSUE_TEMPLATE/pull_request.md
@@ -0,0 +1,25 @@
+## Modificações
+<! --- Forneça um resumo geral de suas modificações ->
+## Descrição
+<! --- Descreva suas modificações em detalhes ->
+## _Issue_ relacionado
+<! --- Este projeto só aceita pedidos _pull_ de _issues_ abertos. ->
+<! --- Se você está propondo um novo recurso ou modificação, primeiro discuta-o com um problema ->
+<! --- Por favor, ligue o problema abaixo: ->
+## Motivação e Contexto
+<! --- Por que essa modificação é necessária? Qual problema resolve? ->
+## Como foi testado?
+<! --- Por favor, escreva todos os detalhes de como suas modificações foram testadas ->
+## Imagens:
+## Tipo de modificações
+<! --- Que tipo de modificações ->
+- [] _ correção de bug_
+- [] Nova _feature_
+
+## Lista de controle:
+- [] Meu código segue a folha de estilos implementada
+- [] Meu _commits_ segue a política de commits do repo.
+- [] Minhas modificações requerem modificações na documentação atual.
+- [] Atualizei a Documentação
+- [] Adicionei testes para cobrir minhas modificações.
+- [] Todos os testes foram aprovados.
diff --git a/README.md b/README.md
@@ -16,12 +16,12 @@ A seguir temos a lista de repositórios utilizados pelo time de desenvolvimento
 
 |                             Foto                             |       Nome       |                                Github                                 |               Email               |
 | :----------------------------------------------------------: | :--------------: | :-------------------------------------------------------------------: | :-------------------------------: |
-| <img src="./docs/images/arthur-profile.jpg" width="200px" /> | Arthur Ferreira  | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) |      [email protected]      |
-|   <img src="./docs/images/cristian.jpeg" width="200px" />    | Cristian Furtado |       [csafurtado](htwidth="200px"tps://github.com/csafurtado)        |    [email protected]    |
-|     <img src="./docs/images/ester.jpg" width="200px" />      |    Ester Lino    |              [esteerlino](https://github.com/esteerlino)              |       [email protected]        |
+| <img src="./docs/assets/images/arthur-profile.jpg" width="200px" /> | Arthur Ferreira  | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) |      [email protected]      |
+|   <img src="./docs/assets/images/cristian.jpeg" width="200px" />    | Cristian Furtado |       [csafurtado](htwidth="200px"tps://github.com/csafurtado)        |    [email protected]    |
+|     <img src="./docs/assets/images/ester.jpg" width="200px" />      |    Ester Lino    |              [esteerlino](https://github.com/esteerlino)              |       [email protected]        |
 |                                                              | Pedro Cabeceira  |              [pkbceira03](https://github.com/pkbceira03)              |      [email protected]      |
-|    <img src="./docs/images/raissa.jpeg" width="200px" />     | Raissa Oliveira  |        [raissamsoliveira](https://github.com/raissamsoliveira)        |   [email protected]    |
-|     <img src="./docs/images/will.jpeg" width="200px" />      | Wildemberg Sales |        [wildemberg-sales](https://github.com/wildemberg-sales)        | [email protected] |
+|    <img src="./docs/assets/images/raissa.jpeg" width="200px" />     | Raissa Oliveira  |        [raissamsoliveira](https://github.com/raissamsoliveira)        |   [email protected]    |
+|     <img src="./docs/assests/images/will.jpeg" width="200px" />      | Wildemberg Sales |        [wildemberg-sales](https://github.com/wildemberg-sales)        | [email protected] |
 
 ## Trabalhando com o MkDocs
 

diff --git a/docs/images/arthur-profile.jpg → docs/assets/images/arthur-profile.jpg b/docs/images/arthur-profile.jpg → docs/assets/images/arthur-profile.jpg
diff --git a/docs/assets/images/favicon.ico b/docs/assets/images/favicon.ico
diff --git a/docs/assets/images/logo2.png b/docs/assets/images/logo2.png
diff --git a/docs/atas-reuniao/ata-04-03-2024.md → docs/atas-reuniao/reuniao1.md b/docs/atas-reuniao/ata-04-03-2024.md → docs/atas-reuniao/reuniao1.md
@@ -35,7 +35,7 @@
 | --- | -------------------- | --------------- | 
 | 1   | Estudo de FastAPI      | Todos         |
 | 2   | Estudo das ferramentas | Todos         |
-| 3   | Participar do onboarding oferecido pelo cliente no dia 12/03 | Ester, Arthur e Willdemberg  |
+| 3   | Participar do onboarding oferecido pelo cliente no dia 12/03 | Ester, Arthur e Wildemberg  |
 
 ### **7. Gravação**
 

diff --git a/docs/index.md b/docs/index.md
@@ -13,9 +13,9 @@ A seguir temos a lista de repositórios utilizados pelo time de desenvolvimento
 ## Contribuidores
 | Foto | Nome | Github | Email |
 | :--: | :--: | :----: | :---: |
-| | Arthur Ferreira | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) | [email protected] |
-| <img src="./images/cristian.jpeg" width="200px" />  | Cristian Furtado | [csafurtado](https://github.com/csafurtado) | [email protected] |
-| <img src="./images/ester.jpg" width="200px" /> | Ester Lino | [esteerlino](https://github.com/esteerlino) | [email protected] |
+| <img src="./assets/images/arthur-profile.jpg" width="200px" /> | Arthur Ferreira | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) | [email protected] |
+| <img src="./assets/images/cristian.jpeg" width="200px" />  | Cristian Furtado | [csafurtado](https://github.com/csafurtado) | [email protected] |
+| <img src="./assets/images/ester.jpg" width="200px" /> | Ester Lino | [esteerlino](https://github.com/esteerlino) | [email protected] |
 | | Pedro Cabeceira | [pkbceira03](https://github.com/pkbceira03) | [email protected] |
-| <img src="./images/raissa.jpeg" width="200px" />| Raissa Oliveira | [raissamsoliveira](https://github.com/raissamsoliveira) | [email protected] |
-| <img src="./images/will.jpeg" width="200px" /> | Wildemberg Sales | [wildemberg-sales](https://github.com/wildemberg-sales) | [email protected] | 
+| <img src="./assets/images/raissa.jpeg" width="200px" />| Raissa Oliveira | [raissamsoliveira](https://github.com/raissamsoliveira) | [email protected] |
+| <img src="./assets/images/will.jpeg" width="200px" /> | Wildemberg Sales | [wildemberg-sales](https://github.com/wildemberg-sales) | [email protected] | 
diff --git a/docs/sprints/sprint1.md b/docs/sprints/sprint1.md
@@ -0,0 +1,22 @@
+# Sprint 01
+
+- Data de início: 25/02/2024
+- Data de término: 02/03/2024
+
+## Objetivos da sprint
+* Planejamento da reunião com o cliente:
+    * dúvidas a serem retiradas sobre as novas funcionalidades solicitadas.
+* Reunião com o cliente:
+    * ocorreu no dia 29/02/2024;
+    * os representantes Giulio e Rebeca estavam presentes;
+    * apresentação sobre o [Querido Diário](https://queridodiario.ok.org.br/);
+    * principais dúvidas sanadas.
+* Estudo da documentação do [Querido Diário](https://queridodiario.ok.org.br/);
+* Estudos sobre as tecnologias e ferramentas que serão usadas no projeto.
+
+
+## Histórico de versão
+
+| Data | Descrição | Autor(es) | Revisor(es) |
+|--------|-------------|--------------|---------------|
+| 06/03/2024 | Criação da estrutura do documento | [Ester Lino](https://github.com/esteerlino)  | [Wildemberg Sales](https://github.com/wildemberg-sales) |
diff --git a/docs/sprints/sprint2.md b/docs/sprints/sprint2.md
@@ -0,0 +1,17 @@
+# Sprint 2
+
+- Data de início: 03/02/2024
+- Data de término: 09/02/2024
+
+## Objetivos da sprint
+* Estudo da documentação do [Querido Diário](https://queridodiario.ok.org.br/);
+* Estudos sobre as tecnologias e ferramentas que serão usadas no projeto;
+* Definição das Histórias de Usuário referentes à funcionalidade 1, solicitada pelo cliente;
+* Organização da documentação do projeto;
+* Organização do Projects no Github.
+
+## Histórico de versão
+
+| Data | Descrição | Autor(es) | Revisor(es) |
+|--------|-------------|--------------|---------------|
+| 06/03/2024 | Criação da estrutura do documento | [Ester Lino](https://github.com/esteerlino)  | [Wildemberg Sales](https://github.com/wildemberg-sales) |
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,17 +14,20 @@ theme:
   text: "Open Sans"
   code: "sans-serif"
   logo: assets/images/logo.png
-  #favicon: assets/images/logo2.png
+  favicon: assets/images/favicon.ico
 
 nav:
   - Início: index.md
   - Atas de Reunião:
-    - Reunião 01: atas-reuniao/ata-04-03-2024.md
+    - Reunião 01: atas-reuniao/reuniao1.md
   - Planejamento:
     - Metodologia: index.md
     - Ferramentas: index.md
     - Cronograma: index.md
     - HeatMap: index.md
+  - Sprints: 
+    - Sprint 01: sprints/sprint1.md
+    - Sprint 02: sprints/sprint2.md
   - Elicitação de Requisitos:
     - Perfil de usuário: index.md
     - Brainstorm: index.md

diff --git a/modelo_doc_sprint.md b/modelo_doc_sprint.md
@@ -0,0 +1,37 @@
+# Sprint 1
+
+- Data de início: --/--/----
+- Data de término: --/--/----
+
+## Objetivos da sprint
+* Objetivo 1;
+    * Detalhes(caso existam)
+* Objetivo 2;
+
+## Backlog da Sprint
+|**US**|**Responsáveis**|
+|--------|-------------|
+| Link para a issue no github | ------------ |
+| Link para a issue no github | ------------ |
+
+## Outras atividades
+|**Atividade**|**Responsáveis**|
+|--------|-------------|
+| Atividade 1 | ----------- |
+| Atividade 2 | ----------- |
+
+
+
+## *Duplas/Pareamento*
+|**Dupla 1**|**Dupla 2**|**Dupla 3**|
+|-----------|-----------|-----------|
+| Membro 1  | Membro 1  | Membro 1  |
+| Membro 2  | Membro 2  | Membro 2  |
+
+## Retrospectiva da sprint 1
+
+## Histórico de versão
+
+| Data | Descrição | Autor(es) |
+|--------|-------------|--------------|
+|        |             |              |