From 66e36d04484e31125916bf34925970763ea09a66 Mon Sep 17 00:00:00 2001 From: Eric Rabelo Date: Thu, 2 May 2024 14:42:25 -0300 Subject: [PATCH] =?UTF-8?q?organizando=20p=C3=A1ginas=20e=20editando=20o?= =?UTF-8?q?=20formato=20das=20apresenta=C3=A7=C3=B5es?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Contribuicao.md | 69 ------------- docs/apresentacoes.md | 21 ++++ docs/entregas.md | 11 +- docs/historia.md | 161 +++++++++++++++++++++++++++++ docs/index.md | 170 +------------------------------ docs/processosDesinvolvimento.md | 2 - mkdocs.yml | 3 +- 7 files changed, 193 insertions(+), 244 deletions(-) delete mode 100644 docs/Contribuicao.md create mode 100644 docs/apresentacoes.md create mode 100644 docs/historia.md delete mode 100644 docs/processosDesinvolvimento.md diff --git a/docs/Contribuicao.md b/docs/Contribuicao.md deleted file mode 100644 index 8fbd32f..0000000 --- a/docs/Contribuicao.md +++ /dev/null @@ -1,69 +0,0 @@ -# Como contribuir? - -Esse markdown serve para verificar como contribuir - -## Git workflow - -O modelo que vamos seguir se baseia em duas branches principais, a "main" e "development", além das ramificações secundárias para features ou correções de bugs. Essa estrutura torna mais claro o ciclo de vida do desenvolvimento, desde a criação de novas funcionalidades até a implantação de versões estáveis. - -### Diagrama do git flow - -![02_Feature_branches.svg](docs/img/gitflow.jpeg) - -#### Fluxo de Desenvolvimento - -Primeiramente, **cada nova mudança deve ser desenvolvida em uma branch exclusiva**, o que facilita o gerenciamento de mudanças e a colaboração da equipe. - -Uma vez que a mudança está pronta para ser incorporada ao projeto, um "Merge Request" (MR) deve ser aberto para a branch "development". Isso permite que a equipe revise a alteração, compartilhe feedback e assegure a aderência aos padrões de qualidade e ao objetivo do projeto. - -Após a aprovação e testes bem-sucedidos em um ambiente de teste ou "stage", a alteração está pronta para ser mesclada na branch "development". Somente após ter sido testada e aprovada nesse ambiente que um commit de "development" para "main" deve ser realizado. Essa abordagem ajuda a manter a branch "main" como uma representação estável e confiável do código do projeto, garantindo que apenas as alterações devidamente validadas sejam incorporadas à versão principal. - -#### Nomeclatura de branches - -A nomeclatura de branches que segue o padrão **"tipo-da-mudança/descrição"** é uma abordagem estruturada e informativa para gerenciar branches em repositórios de controle de versão, especialmente no contexto de commits convencionais. Essa convenção de nomenclatura utiliza tokens derivados dos tipos de mudanças definidos no padrão de commits convencionais para categorizar as branches de forma clara e compreensível. - -A estrutura **"tipo-da-mudança/nome-descritivo"** pode ser desdobrada da seguinte maneira: - -1. **Tipo da Mudança (Token)**: O tipo da mudança é um token que descreve a natureza da alteração que está sendo realizada na branch. Esses tokens são extraídos dos tipos descritos no Conventional Commits, e estão descritos na seção `Politica de Commits.` - -2. **descrição**: É uma breve descrição que esclarece o propósito da branch de forma clara e concisa. Deve explicar o que está sendo desenvolvido na branch, para que outras pessoas da equipe possam entender facilmente a sua finalidade. - -Por exemplo, se você estiver criando uma branch para adicionar um novo recurso de pesquisa em um projeto de software, a nomeclatura pode seguir o formato "feat/relatorio-mobilizacao" ou "feat/busca." Isso torna evidente que a branch se destina à implementação de um novo recurso de pesquisa. - -## Politica de Commits - -A nossa política de commits adota o padrão Conventional Commits como diretriz fundamental para o registro de alterações no nosso código. Este padrão incentiva a clareza e consistência nas mensagens de commit, facilitando a compreensão e rastreamento das mudanças ao longo do tempo. - -Padrão de commit - -### **prefixo(sufixo): descrição** - -**Exemplo**: - -```markdown -docs(dag-notificacao-proposta): documentação inicial da dag de envio de mensagem de novas propostas. -``` - -### Prefixo - -- **feat**: Utilizado para novas funcionalidades ou adições ao código. Feat de features. -- **fix**: Usado para correções de bugs. -- **chore**: Geralmente associado a tarefas de manutenção, ajustes de configuração ou outras atividades não relacionadas a funcionalidades ou bugs. -- **docs**: Reservado para alterações na documentação. -- **refactor**: Utilizado quando há refatoração de código sem alterar comportamento externo. -- **test**: Associado a adições ou modificações nos testes. -- **build**: Relacionado a mudanças no sistema de build ou dependências. -- **ci**: Envolvendo ajustes ou melhorias em configurações de integração contínua. -- **perf**: Usado para melhorias de desempenho. -- **revert**: Utilizado para reverter uma alteração anterior. - -### Sufixo - -No sufixo, deve estar em parentese aonde que está sendo feita a mudança, seguido de dois pontos e sua mensagem. - -## Revisão e qualidade do código - -Para manter a qualidade do código, adotamos uma série de medidas automatizadas e de padrão de código. - -## Todo código deve ter seu arquivo de testes e deve passar na análise estática do Mypy. - - ***Justificativa:*** Incorporar testes unitários e análise estática com o MyPy é crucial para assegurar a robustez do código. O MyPy, ao realizar verificações estáticas de tipo, ajuda a identificar potenciais bugs antes que o código entre em produção, aumentando a confiança na qualidade do software. diff --git a/docs/apresentacoes.md b/docs/apresentacoes.md new file mode 100644 index 0000000..463f93b --- /dev/null +++ b/docs/apresentacoes.md @@ -0,0 +1,21 @@ +## História da Facção + +
+ +
+ +--- + +## Processos de Desenvolvimento de Software + +
+ +
diff --git a/docs/entregas.md b/docs/entregas.md index f38bb10..4b23a31 100644 --- a/docs/entregas.md +++ b/docs/entregas.md @@ -1,4 +1,9 @@ -### Entrega - Unidade 1 +## Unidade 1 - ---- \ No newline at end of file +
+ +
diff --git a/docs/historia.md b/docs/historia.md new file mode 100644 index 0000000..7a551d8 --- /dev/null +++ b/docs/historia.md @@ -0,0 +1,161 @@ +

DataDiggers

+ + +## História e Personagens + +
+
+
+

+ Em uma jornada audaciosa pelo cosmos, a equipe de exploradores espaciais DataDiggers se aventurou em busca das misteriosas tumbas piramidais + (Query) de um planeta distante. Contudo, sua expedição logo se tornou uma luta desesperada pela sobrevivência quando um encontro inesperado com uma + tecnologia antiga resultou em uma infecção devastadora. Enquanto exploravam uma dessas tumbas, os DataDiggers encontraram artefatos contendo nanorrobôs adormecidos há milênios. Inadvertidamente, ao perturbarem esses artefatos, liberaram uma nuvem de nanorrobôs que infectaram cada membro da equipe, reprogramando seus corpos e mentes em um nível fundamental. +

+
+
+ +

Brasão da facção.

+
+
+

+ À medida que os dias passavam, os membros da equipe começaram a notar + mudanças alarmantes em seus corpos. Suas células eram reconfiguradas lentamente pelos nanorrobôs, fundindo tecnologia e biologia de maneiras + estranhas e imprevisíveis. Novas habilidades surgiam, mas também surgiam efeitos colaterais indesejados, ameaçando a própria essência de sua + humanidade. Agora, os Datadiggers viajam pela galáxia em busca de uma cura para a infecção que os consome. Em cada planeta visitado, procuram por + artefatos, conhecimentos antigos ou aliados poderosos que possam oferecer uma solução para seu dilema. Cada sistema estelar explorado é uma corrida + contra o tempo, pois os efeitos da infecção só se intensificam com o passar dos dias. +

+
+ +--- + + +
+
+
+

Robô Explorador de Query 01

+

+ REQ1 cresceu em um planeta na galáxia de Calamum Caerulium ouvindo as emocionantes histórias de exploração de seus pais, enquanto a galáxia + enfrentava turbulências causadas por corporações vorazes e conflitos como os promovidos pelo grupo Apache. Determinado a entender a desordem + galáctica, REQ1 explorou ruínas antigas em seu planeta, mas sem respostas satisfatórias. Inspirado pelos pais, fundou a facção Data Diggers para + explorar a galáxia em busca de mais ruínas e respostas, especialmente com os conflitos se intensificando em Calamum Caerulium. +

+
+
+ +
+
+
+ +--- + +
+
+
+

Robô Explorador de Query 02

+

+ REQ 2 cresceu em uma pequena colônia no limite da galáxia, onde a vida era dura e os recursos escassos. Desde jovem, ela sonhava em escapar da + monotonia da vida na colônia e explorar os vastos cosmos além. Seu desejo de aventura foi finalmente realizado quando uma equipe de exploradores, + os DataDiggers, visitou sua colônia em busca de novos recrutas. Inspirada pelo espírito destemido dos exploradores e pelo desejo de descobrir novos + mundos, ela se juntou à equipe, ansiosa para começar sua própria jornada. Para REQ 2, a vida como uma exploradora era mais do que apenas uma + aventura; era uma chance de descobrir seu verdadeiro potencial e fazer a diferença no universo. +

+
+
+ +
+
+
+ +--- + +
+
+
+

Robô Explorador de Query 03

+

+ Nascido de Nômades, REQ3 sempre viajou em seu planeta conhecendo novas culturas, locais e culinarias diferentes, sempre atento as estrelas e + sonhando em desbravar diversos mundos e suas peculiaridades, estudou sobre sistemas de navegação estelar e se juntou ao grupo DataDiggers como + navegador para poder experienciar mais do que esse vasto universo tem a oferecer. +

+
+
+ +
+
+
+ +--- + +
+
+
+

Robô Explorador de Query 04

+

+ Diante da exploração desenfreada das corporações espaciais, várias famílias foram forçadas a fugir em naves desesperadas por escapar do caos que + engolia seu lar. Entre os inúmeros fugitivos estava REQ4, cuja família desapareceu misteriosamente durante a fuga. Adotado por uma família de + cientistas desbravadores e crescendo em meio a experimentos e expedições intergalácticas, REQ4 absorveu o espírito aventureiro, assim, decide se + juntar ao grupo de exploradores conhecido como Datadiggers. Determinado a encontrar pistas sobre o que aconteceu com sua família, REQ4 embarca em + uma jornada repleta de perigos e mistérios. +

+
+
+ +
+
+
+ +--- + +
+
+
+

Robô Explorador de Query 05

+

+ REQ 5 era uma engenheira que vivia pacificamente com sua família até a invasão da Corporação Spark Tech, que devastou sua aldeia e deixou seu povo + completamente desolado. Determinada a resistir, REQ 5 se juntou a um grupo de exploradores interestelares, viajando entre os planetas em busca de + recursos para ajudar os seus irmãos a se reerguerem e procurando incessantemente pelos entes queridos que desapareceram durante o ataque. Ela + persiste na esperança de um dia reunir sua família e restaurar a liberdade de sua comunidade. +

+
+
+ +
+
+
+ +--- + +
+
+
+

Robô Explorador de Query 06

+

+ REQ6, fascinada pelo cosmos desde jovem, se torna uma engenheira espacial talentosa. Durante sua primeira missão, enfrenta uma série de desafios, + incluindo uma tempestade de detritos cósmicos, mas com determinação e coragem, consegue retornar à segurança de sua casa. Sua jornada épica a torna + uma lenda entre os exploradores do espaço, inspirando futuras gerações a sonhar com as estrelas. +

+
+
+ +
+
+
+ +--- + +
+
+
+

Robô Explorador de Query 07

+

+ Um jovem órfão que vivia à margem da lei, sobrevivendo como podia em meio ao caos da galáxia deixado pelas corporações gananciosas. Sua vida mudou + drasticamente quando foi recrutado por REQ1, líder da equipe Datta Diggers. Apesar de suas origens como fora da lei, demonstrou habilidades únicas + e uma determinação inabalável, tornando-se rapidamente um membro valioso da equipe. +

+
+
+ +
+
+
\ No newline at end of file diff --git a/docs/index.md b/docs/index.md index f36035f..0c79942 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,10 +2,6 @@ O produto proposto é App que busca resolver os problemas de gestão de estoque e controle de vendas de uma loja de materiais de construção. Atualmente, o cliente utiliza planilhas excel para fazer o controle do estoque da loja, o que, além de não garantir a integridade dos dados, também consome muito tempo e esforço. O público alvo do DataMix serão os funcionários da loja de construção CONSTRUMIX. Nossa aplicação busca automatizar o controle do estoque dos produtos e fornecer uma informação detalhada do fluxo de caixa da loja. -
- -
- ## Equipe
@@ -54,169 +50,5 @@ O produto proposto é App que busca resolver os problemas de gestão de estoque - -
- ---- - -

DataDiggers

- - -## História e personagens - -
-
-
-

- Em uma jornada audaciosa pelo cosmos, a equipe de exploradores espaciais DataDiggers se aventurou em busca das misteriosas tumbas piramidais - (Query) de um planeta distante. Contudo, sua expedição logo se tornou uma luta desesperada pela sobrevivência quando um encontro inesperado com uma - tecnologia antiga resultou em uma infecção devastadora. Enquanto exploravam uma dessas tumbas, os DataDiggers encontraram artefatos contendo nanorrobôs adormecidos há milênios. Inadvertidamente, ao perturbarem esses artefatos, liberaram uma nuvem de nanorrobôs que infectaram cada membro da equipe, reprogramando seus corpos e mentes em um nível fundamental. -

-
-
- -

Brasão da facção.

-
-
-

- À medida que os dias passavam, os membros da equipe começaram a notar - mudanças alarmantes em seus corpos. Suas células eram reconfiguradas lentamente pelos nanorrobôs, fundindo tecnologia e biologia de maneiras - estranhas e imprevisíveis. Novas habilidades surgiam, mas também surgiam efeitos colaterais indesejados, ameaçando a própria essência de sua - humanidade. Agora, os Datadiggers viajam pela galáxia em busca de uma cura para a infecção que os consome. Em cada planeta visitado, procuram por - artefatos, conhecimentos antigos ou aliados poderosos que possam oferecer uma solução para seu dilema. Cada sistema estelar explorado é uma corrida - contra o tempo, pois os efeitos da infecção só se intensificam com o passar dos dias. -

-
- ---- - - -
-
-
-

Robô Explorador de Query 01

-

- REQ1 cresceu em um planeta na galáxia de Calamum Caerulium ouvindo as emocionantes histórias de exploração de seus pais, enquanto a galáxia - enfrentava turbulências causadas por corporações vorazes e conflitos como os promovidos pelo grupo Apache. Determinado a entender a desordem - galáctica, REQ1 explorou ruínas antigas em seu planeta, mas sem respostas satisfatórias. Inspirado pelos pais, fundou a facção Data Diggers para - explorar a galáxia em busca de mais ruínas e respostas, especialmente com os conflitos se intensificando em Calamum Caerulium. -

-
-
- -
-
-
- ---- - -
-
-
-

Robô Explorador de Query 02

-

- REQ 2 cresceu em uma pequena colônia no limite da galáxia, onde a vida era dura e os recursos escassos. Desde jovem, ela sonhava em escapar da - monotonia da vida na colônia e explorar os vastos cosmos além. Seu desejo de aventura foi finalmente realizado quando uma equipe de exploradores, - os DataDiggers, visitou sua colônia em busca de novos recrutas. Inspirada pelo espírito destemido dos exploradores e pelo desejo de descobrir novos - mundos, ela se juntou à equipe, ansiosa para começar sua própria jornada. Para REQ 2, a vida como uma exploradora era mais do que apenas uma - aventura; era uma chance de descobrir seu verdadeiro potencial e fazer a diferença no universo. -

-
-
- -
-
-
---- - -
-
-
-

Robô Explorador de Query 03

-

- Nascido de Nômades, REQ3 sempre viajou em seu planeta conhecendo novas culturas, locais e culinarias diferentes, sempre atento as estrelas e - sonhando em desbravar diversos mundos e suas peculiaridades, estudou sobre sistemas de navegação estelar e se juntou ao grupo DataDiggers como - navegador para poder experienciar mais do que esse vasto universo tem a oferecer. -

-
-
- -
-
-
- ---- - -
-
-
-

Robô Explorador de Query 04

-

- Diante da exploração desenfreada das corporações espaciais, várias famílias foram forçadas a fugir em naves desesperadas por escapar do caos que - engolia seu lar. Entre os inúmeros fugitivos estava REQ4, cuja família desapareceu misteriosamente durante a fuga. Adotado por uma família de - cientistas desbravadores e crescendo em meio a experimentos e expedições intergalácticas, REQ4 absorveu o espírito aventureiro, assim, decide se - juntar ao grupo de exploradores conhecido como Datadiggers. Determinado a encontrar pistas sobre o que aconteceu com sua família, REQ4 embarca em - uma jornada repleta de perigos e mistérios. -

-
-
- -
-
-
- ---- - -
-
-
-

Robô Explorador de Query 05

-

- REQ 5 era uma engenheira que vivia pacificamente com sua família até a invasão da Corporação Spark Tech, que devastou sua aldeia e deixou seu povo - completamente desolado. Determinada a resistir, REQ 5 se juntou a um grupo de exploradores interestelares, viajando entre os planetas em busca de - recursos para ajudar os seus irmãos a se reerguerem e procurando incessantemente pelos entes queridos que desapareceram durante o ataque. Ela - persiste na esperança de um dia reunir sua família e restaurar a liberdade de sua comunidade. -

-
-
- -
-
-
- ---- - -
-
-
-

Robô Explorador de Query 06

-

- REQ6, fascinada pelo cosmos desde jovem, se torna uma engenheira espacial talentosa. Durante sua primeira missão, enfrenta uma série de desafios, - incluindo uma tempestade de detritos cósmicos, mas com determinação e coragem, consegue retornar à segurança de sua casa. Sua jornada épica a torna - uma lenda entre os exploradores do espaço, inspirando futuras gerações a sonhar com as estrelas. -

-
-
- -
-
-
- ---- - -
-
-
-

Robô Explorador de Query 07

-

- Um jovem órfão que vivia à margem da lei, sobrevivendo como podia em meio ao caos da galáxia deixado pelas corporações gananciosas. Sua vida mudou - drasticamente quando foi recrutado por REQ1, líder da equipe Datta Diggers. Apesar de suas origens como fora da lei, demonstrou habilidades únicas - e uma determinação inabalável, tornando-se rapidamente um membro valioso da equipe. -

-
-
- -
-
-
\ No newline at end of file + diff --git a/docs/processosDesinvolvimento.md b/docs/processosDesinvolvimento.md deleted file mode 100644 index 68f6513..0000000 --- a/docs/processosDesinvolvimento.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/mkdocs.yml b/mkdocs.yml index 0cbcbbb..ead95b9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,8 +43,9 @@ extra_css: nav: - Início: index.md - - Processos de Desenvolvimento de Software: processosDesinvolvimento.md + - História: historia.md - Visão do Produto e Projeto: documentoVisao.md + - Apresentações: apresentacoes.md - Entregas: entregas.md markdown_extensions: