From 4cd82cfe9de19f4c7ac3cc34dd1893d42a785ead Mon Sep 17 00:00:00 2001 From: MateuSansete Date: Thu, 12 Dec 2024 03:22:52 -0300 Subject: [PATCH] =?UTF-8?q?Corre=C3=A7=C3=B5es=20estruturais=20mkdocs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/padronizacaoGit.md | 2 +- docs/padronizacaoIssues.md | 36 ++++++++++++++++++------------------ mkdocs.yml | 6 +++--- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/padronizacaoGit.md b/docs/padronizacaoGit.md index d0f5c159..95b44c2a 100644 --- a/docs/padronizacaoGit.md +++ b/docs/padronizacaoGit.md @@ -51,6 +51,6 @@ Exemplo de commit: [refact](#25): ajustando página de login -## Pull Request +# Pull Request Por meio do processo de pull request, realizado no GitHub, toda nova funcionalidade deve ser integrada à branch Main. Mas isso semente será feito após todos os critérios de sucesso para a feature estarem atendidos. diff --git a/docs/padronizacaoIssues.md b/docs/padronizacaoIssues.md index 6515c81d..6a2a1d55 100644 --- a/docs/padronizacaoIssues.md +++ b/docs/padronizacaoIssues.md @@ -1,6 +1,6 @@ -# Estrutura da Issue +## Estrutura da Issue -## Título da Issue +# Título da Issue Use um título claro e descritivo. **Formato sugerido**: @@ -10,24 +10,24 @@ Use um título claro e descritivo. --- -## Descrição +# Descrição Preencha os seguintes campos para descrever a issue: -### Resumo +# Resumo Breve descrição da issue. -### Contexto +# Contexto - Explique o problema ou a necessidade. - Inclua links ou referências relevantes, se houver. -### Critérios de Aceitação +## Critérios de Aceitação Liste os requisitos necessários para que a issue seja considerada resolvida. **Exemplo**: - O botão X está funcionando conforme o esperado. - O endpoint retorna os dados corretamente. -### Tarefas +# Tarefas Liste as etapas necessárias para completar a issue: 1. Etapa 1 2. Etapa 2 @@ -35,7 +35,7 @@ Liste as etapas necessárias para completar a issue: --- -## Prioridade +# Prioridade Indique a prioridade da issue: - **Alta**: Impacta diretamente o funcionamento principal do sistema. @@ -44,13 +44,13 @@ Indique a prioridade da issue: --- -## Anexos +# Anexos Inclua imagens, logs ou exemplos de código, se necessário. --- -## 🚀 Boas Práticas +# Boas Práticas - Mantenha as issues objetivas e claras. - Atualize a issue à medida que houver progresso. @@ -61,31 +61,31 @@ Inclua imagens, logs ou exemplos de código, se necessário. ## Exemplo de Issue Preenchida -### Título +# Título `[BUG] Erro ao carregar o mapa interativo` -### Descrição +## Descrição -#### Resumo +# Resumo O mapa interativo não está carregando ao acessar a página inicial. -#### Contexto +# Contexto - O problema ocorre em todas as sessões de usuário ao usar navegadores baseados em Chromium. - Logs de erro no console indicam falha na comunicação com o endpoint `/api/map`. -#### Critérios de Aceitação +# Critérios de Aceitação - O mapa carrega corretamente em navegadores compatíveis. - Logs de erro são tratados adequadamente. -#### Tarefas +# Tarefas 1. Investigar o erro no endpoint `/api/map`. 2. Corrigir a falha de comunicação. 3. Validar o funcionamento em diferentes navegadores. -### Prioridade +# Prioridade **Alta** -### Anexos +# Anexos - Captura de tela do erro no console. - Logs detalhados do servidor. diff --git a/mkdocs.yml b/mkdocs.yml index eec5106f..5082da56 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,9 +7,9 @@ nav: - Sprint 1: sprints/sprint-1.md - Projeto: - Arquitetura e Tecnologias: projects/arquitetura.md - - Padrões: # Novo link de navegação - - Padrão 1: padronizacaoGit.md # Primeiro arquivo - - Padrão 2: padronizacaoIssues.md # Segundo arquivo # Novo link de navegação + - Padronização: # Novo link de navegação + - Git: padronizacaoGit.md # Primeiro arquivo + - Issues: padronizacaoIssues.md # Segundo arquivo - Sobre: about.md theme: