Skip to content

02 ‐ Padrões de Projeto da Equipe

Gabriel Reis edited this page Sep 23, 2024 · 21 revisions

2.1 - Padrões de Projeto da Equipe

Nesta seção serão abordados os parâmetros e regras de desenvolvimento de projeto da equipe. A grosso modo, será explicado como a equipe se organizou para desenvolver o produto. Essa seção contará com os seguintes temas:

  • Modelo e regras na criação de tasks;
  • Regras para Aceitação de tasks;
  • Modelo e regras de branch;
  • Modelo e regras de commits;
  • Modelo e regras de pull-request;
  • Regras de review de pull-request;
  • Regras de teste de código;

2.2 - Regras na criação de tasks

A fim de tornar mais dinâmico e eficiente o desenvolvimento, criamos este "padrão de tasks", seu objetivo é servir como um modelo e explanar o porque desse modelo. Primeiramente é válido deixar explicito que a equipe optou por gerenciar as tasks na plataforma do Github, na aba "Projects", logo, tanto regra quanto modelo q serão apresentados, são baseados nesse cotexto.

O modelo é o seguinte:

nome do card - vertente 
dificuldade - prioridade
------------------------
**_Oque fazer_**: inserir o que fazer;
**_Restrições_**: inserir restrições, se houver;
**_Falha_**: inserir casos que podem falhar e o que deve acontecer;
**_Conteúdo_**: inserir o conteúdo a ser exibido ou tratado;
link para figma (se for task com vertente do front)
------------------------
aceitação;
------------------------
data inicio - data conclusão
  • nome do card: É o nome da tarefa, precisa ser o mais simples possível;
  • vertente: Front ou Back;
  • dificuldade: o quão difícil é para a equipe de modo geral, realizar aquela tarefa;
  • prioridade: o quão urgente é aquela tarefa?
  • descrição: é a abordagem das instruções da tarefa, como fazer, atenções, tudo que envolve o processo dessa tarefa deve ser explicado;
  • aceitação: quando a tarefa pode ser dada como concluída e abrir o pull-request?
  • data inicio e data coclusão: o encarregado da tarefa deve inserir estes valores, quando começar e quando terminar a tarefa;

exemplo:

Nome do card Vertente Dificuldade Prioridade Descrição Aceitação Data de Inicio Data de conclusão
Home-page Front Facil Baixa Oque fazer: Criar uma tela, em que, o usuário será direcionado quando fizer o login. Essa tela contará com um dashboard centralizado no centro da página, exibindo dados de indicativos gerais sendo possível filtrar os dados por data especifica (inicio - fim), a tela deve possuir um menu de navegação e sua rota deve ser: "/home", qualquer usuário pode acessa-la e seu esquema de cores deve seguir a paleta definida.

Restrições: Só poderá acessar se estiver logado.

Falha: 1. Se o dashboard não possuir dados suficientes, exibir uma mensagem de dados insuficientes ao invés de exibir os dados; 2. Se o usuário tiver com a sesão expirada, no próximo evento que for acionado nesta página ele deverá ser direcionado para o Login novamente e os dados da sesão, se estiverem salvos, devem ser limpados.

Conteúdo: Dashboard e Menu
1. O usuário é direcionado para essa página assim que faz o login?

2. A rota "/home" leva para essa página?

3. O página possuí todos os componentes?

4. O dashboard consegue filtrar os dados por data?

5. O dashboard exibe a mensagem de falha no caso de falha?
21/01/2024 21/01/2024

Desenvolvido pela equipe: SyntaxSquad, composta por alunos do 4º semestre, do tecnólogo em Desenvolvimento de Software Multiplataforma, na FATEC Profº Jessen Vidal - São José dos Campos, SP, 2024

Clone this wiki locally