Padrões de Desenvolvimento

Esta seção descreve as melhores práticas, ferramentas e orientações que são adotadas pela equipe de desenvolvimento do sistema Redome.

Contrato Social da Equipe

O contrato social é um acordo feito entre os membros da equipe de desenvolvimento do sistema Redome e tem a função de destabelecer boas práticas para o dia-a-dia de trabalho. As diretrizes a seguir foram redijidas com os membros da equipe de desenvolvimento, e não representa uma obrigação, mas um comprometimento informal entre o time.

Cerimônias

1. A daily scrum meeting conta com a presença de todo o Dev Team com 15 minutos de duração com o objetivo de compartilhar o trabalho e identificação de impedimentos
2. Assegurar que todas as reuniões tenham uma agenda e que as ações sejam registradas
3. Se você não puder participar ou precisar sair mais cedo de uma reunião, notifique a equipe antes
4. Venha preparado para reuniões
5. Seja pontual ( as reuniões começam no horário agendado independente da presença de todos )

Fluxo de Trabalho

1. Se receber/pegar um trabalho, apropriar-se dele e mantê-lo atualizado
2. Se você acha que precisa trabalhar até tarde para fazer o trabalho, acordar com o Scrum Master/GC

Comunicação

1. Avise para o scrum master de forma imediata caso tenha um problema
2. Respeitar um ao outro e compreender as diferenças de conhecimento
3. Demonstrar respeito tanto com palavras quanto atitudes
4. Todos os documentos da equipe devem ser compartilhados
5. Não há perguntas tolas, se você não entender, pergunte
6. Não faça inferências, pergunte
7. Concentre-se nos aspectos positivos
8. Respeitar quando outra pessoa do time estiver falando

Padrões

Banco de Dados

Padronização de nomenclatura de estrutura de dados e diretrizes para a criação de qualquer objeto no banco de dados tal como tabelas, colunas, chaves primárias, estrangeiras, índices, dentre outros.

[ Mostrar Padrão ]

Codificação

Convenções de codificação para o desenvolvimento do backend (Java) e frontend (Angular) do sistema Redome. Esse padrão define as regras de como o código-fonte deve ser escrito.

[ Mostrar Padrão ]

Documentação

Diretrizes para documentar o código-fonte de modo a explicar O QUE faz cada classe e método do sistema Redome. A documentação não pretende explicar COMO cada método faz o que faz, porque o desenvolvedor interessado nesse assunto deve ser capaz de ler o código-fonte.

[ Mostrar Padrão ]

Testes Unitários

Padrão para escrever os testes unitários automatizados e orientação para utilização da técnica de desenvolvimento dirigido por testes (TDD).

[ Mostrar Padrão ]

Arquitetura do Sistema:

Este seção detalha as diretrizes de arquitetura que nortearam o desenvolvimento do sistema e aprenta a visão geral da arquitetura da solução do Projeto de Modernização do Redome, expondo as perspectivas funcionais e não funcionais relacionadas à solução.

A arquitetura de sistemas é responsável por conceituar e representar os componentes de software, suas propriedades externas e relacionamentos, bem como os direcionadores que justificam sua existência dentro da solução proposta.

Visão Geral

Esta seção descreve o contexto do projeto, os processos de negócio envolvidos e detalha como o sistema computacional está organizado em termos de seus componentes de software.

[ Mostrar Padrão ]

Requisitos não funcionais

Os Requerimentos não funcionais remetem a aspectos que, embora não afetem diretamente as funcionalidades do sistema sob a ótica de negócio dos usuários, pode ter um profundo efeito na forma como o sistema é aceito pelos usuários e pessoas que dão suporte ao sistema.

[ Mostrar Padrão ]

Princípios de Arquitetura

Nesta seção estão descritos os princípios de arquitetura para o sistema computacional objeto deste projeto. Tais princípios são definições de alto nível de valores fundamentais, regras gerais e diretrizes que orientam o processo de tomada de decisões técnicas, servindo de base para a arquitetura e desenvolvimento deste sistema.

[ Mostrar Padrão ]

Modelo Operacional

O modelo operacional tem por objetivo definir e documentar a forma como os componentes do sistema serão desenvolvidos e distribuídos em nós, junto com as conexões necessárias para suportar as interações requeridas por estes, de forma a atender os requerimentos funcionais e não funcionais da solução, considerando as restrições de tecnologia.

[ Mostrar Padrão ]

Decisões de Arquitetura

Esta seção reune e apresentar as decisões arquiteturais relacionadas ao projeto, detalhando as razões e justificativas que motivaram cada decisão.

[ Mostrar Padrão ]

Ferramentas & Frameworks para:

A seguir estão detalhadas as ferramentas utilizadas no processo de desenvolvimento do sistema Redome.

Realizar Teste de Software

[ Ler Mais ]

Orientações para:

Configurar o ambiente de desenvolvimento

[ Mostrar Orientação ]

Controlar as mudanças feitas no código (GIT)

[ Mostrar Orientação ]

Realizar a revisão do código-fonte

[ Mostrar Orientação ]

Organizar a estrutura do código-fonte

[ Mostrar Orientação ]

Efetuar correções de bugs em produção/homologação

[ Mostrar Orientação ]

Como acessar o Build Pipeline

[ Mostrar Orientação ]

Configurar container Kubernete da Wiki Redome

[ Mostrar Orientação ]