Home

Olá! Seja bem-vindo(a) à nossa página de documentação do projeto.
Aqui você encontrará informações detalhadas sobre o projeto e seu desenvolvimento.

Sobre o projeto

Nosso projeto é um sistema de coleta de dados de estações meteorológicas, criado com o objetivo de fornecer uma ferramenta capaz de prevenir desastres naturais por meio da geração de alertas. O sistema coleta dados dos sensores, processa essas informações e as apresenta em um portal que disponibiliza relatórios, dashboards e explicações dos conceitos matemáticos aplicados nos cálculos. Além disso, destaca a importância do monitoramento ambiental como uma ferramenta essencial para a prevenção de desastres.

O que você vai encontrar aqui

• Padrão de Branch: Descrição de como as tarefas são incorporadas e desenvolvidas ao projeto.
• Documentação DevOps: Metodologia que integra desenvolvimento (Dev) e operações (Ops) visando melhorar a colaboração e eficiência. Objetivando a entrega contínua de software com qualidade e velocidade.

Padrão de Branch

Uma branch deve ser criada a partir na main sempre que uma tarefa for iniciada. O nome da branch segue o padrão: Task - <número da task>

Por exemplo:

• Task-1
• Task-42

Padrão de Commit

Existem dois padrões para os commits, um referente ao desenvolvimento direto da task e outro para ajustes que não estão ligados diretamente a nenhuma task.

Commit de Task

Neste caso podemos abordar duas situações: Commits de desevolvimento e Commits para mudança de status da task. Commits relacionados ao desenvolvimento da task devem seguir o formato: RF- <descrição do commit> TG-<ID da Task>. Para Commits de mudança de status da task devem seguir o formato: TG-<ID da Task> #<status-slug>. Padrões estes já pré-estabelecidos pelo Taiga (software de gerenciamento de projetos).

Exemplos:

• RF-1 Adição da rota de cadastro de estação TG-1 para requisito funcional
• RFN-1 Adição da rota de cadastro de estação TG-1 para requisito não funcional
• TG-1 #closed

Commit Geral

Os commits que não estão relacionados diretamente a uma task devem seguir o formato: <tipo>: <descrição do commit>

Tipos de Commit Geral

• fix - Indica que o trecho de código commitado está solucionando um problema ou bug.
• docs - Indica que houveram mudanças na documentação.
• test - Indica que houveram alterações criando, alterando ou excluindo testes;
• build - Indica que houveram alterações relacionadas a build do projeto/dependências.
• refactor - Indica que uma parte do código foi refatorada sem alterar nenhuma funcionalidade.
• ci - Indica mudanças relacionadas a integração contínua (Continuous Integration).
• cleanup - Indica a remoção de código comentado ou trechos desnecessários no código-fonte.
• remove - Indica a exclusão de arquivos, diretórios ou funcionalidades obsoletas ou não utilizadas.

Exemplos:

• fix: Correção na exibição do elemento X
• docs: Documentação da funcionalidade Y