Skip to content

[Tipo] - [Módulo/Função] - [Resumo da Tarefa]

Use um título claro que descreva o tipo de tarefa, o módulo ou função afetada, e um resumo breve da tarefa.

  • [Tipo]: Identifique se é uma nova funcionalidade (Feature), correção de bug (Bug), melhoria (Enhancement), etc.
  • [Módulo/Função]: Indique o componente ou módulo específico do sistema.
  • [Resumo da Tarefa]: Uma breve descrição da tarefa.

Exemplo: Feature - Autenticação - Implementar JWT para autenticação

Descrição

Explicação detalhada da tarefa, descrevendo o objetivo e a importância no contexto do sistema. Forneça uma visão geral do que precisa ser feito e, se possível, o problema que a tarefa resolve.

Exemplo: Implementar autenticação JWT para garantir que apenas usuários autenticados acessem os endpoints protegidos.

Critérios de Aceitação

Especifique os requisitos necessários para que a tarefa seja considerada concluída. Cada critério deve ser uma condição observável ou testável que confirme a implementação correta da tarefa.

  • [ ] Critério 1 Exemplo: Usuário deve receber um token JWT válido após login bem-sucedido
  • [ ] Critério 2 Exemplo: Token JWT deve expirar após X horas
  • [ ] Critério 3 Exemplo: Usuários não autenticados devem receber erro 401 ao acessar endpoints protegidos

Escopo da Tarefa

Detalhe as etapas ou sub-tarefas envolvidas na execução da tarefa. Cada passo deve ser uma ação específica necessária para atingir o objetivo final.

  • [ ] Passo 1: Explicação detalhada do que deve ser feito. Exemplo: Criar endpoint para login
  • [ ] Passo 2: Explicação detalhada do que deve ser feito. Exemplo: Gerar e retornar o token JWT
  • [ ] Passo 3: Explicação detalhada do que deve ser feito. Exemplo: Configurar middleware para validar JWT nos endpoints protegidos

Técnicas e Ferramentas Necessárias

Liste as tecnologias, bibliotecas e frameworks que serão utilizados na implementação. Incluir as ferramentas específicas evita retrabalho e alinha as expectativas com as ferramentas padrão da equipe.

  • Framework: Exemplo: Node.js + Express
  • Biblioteca: Exemplo: jsonwebtoken para geração e validação do JWT
  • Banco de Dados: Exemplo: PostgreSQL para armazenar dados do usuário

Informações Adicionais

Qualquer informação adicional que seja relevante para a execução da tarefa, como documentação de tecnologias específicas, exemplos de código ou links úteis para referência.

Exemplo: Documentação da biblioteca JWT: [Link para documentação](https://www.npmjs.com/package/jsonwebtoken)