Skip to content

Commit

Permalink
Correções estruturais mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
MateuSansete committed Dec 12, 2024
1 parent 9dc7fd3 commit 4cd82cf
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/padronizacaoGit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
36 changes: 18 additions & 18 deletions docs/padronizacaoIssues.md
Original file line number Diff line number Diff line change
@@ -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**:
Expand All @@ -10,32 +10,32 @@ 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
3. Etapa 3

---

## Prioridade
# Prioridade

Indique a prioridade da issue:
- **Alta**: Impacta diretamente o funcionamento principal do sistema.
Expand All @@ -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.
Expand All @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 4cd82cf

Please sign in to comment.