From 87f1d83f0e0385fd41b962b93cfb95920d35040f Mon Sep 17 00:00:00 2001 From: PedroLock Date: Mon, 19 Aug 2024 16:04:44 -0300 Subject: [PATCH 1/4] mantenabilidade e desenvolvimento --- docs/Desenvolvimento.md | 86 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 docs/Desenvolvimento.md diff --git a/docs/Desenvolvimento.md b/docs/Desenvolvimento.md new file mode 100644 index 0000000..5ff2647 --- /dev/null +++ b/docs/Desenvolvimento.md @@ -0,0 +1,86 @@ +import os + +# Define o caminho do diretório 'docs' onde a página será criada +docs_dir = "docs" +page_filename = "mantenabilidade_desenvolvimento.md" + +# Cria o conteúdo da página +page_content = """ +# Mantenabilidade e Desenvolvimento + +Esta página fornece diretrizes de codificação e uma visão geral da estrutura do repositório para garantir a qualidade, a consistência e a mantenabilidade do código ao longo do desenvolvimento do projeto. + +## Diretrizes de Codificação + +### Padrões de Estilo e Convenções + +1. **Nomenclatura:** + - Use nomes descritivos e consistentes para variáveis, funções, classes e arquivos. + - Siga o padrão `snake_case` para nomes de variáveis e funções em Python e `CamelCase` para nomes de classes. + +2. **Documentação:** + - Todos os módulos, classes e funções devem ser documentados com docstrings que seguem o padrão do [PEP 257](https://www.python.org/dev/peps/pep-0257/). + - Adicione comentários esclarecendo blocos de código complexos ou decisões importantes. + +3. **Formatação:** + - Utilize `black` como formatador de código para garantir consistência. + - Limite o comprimento das linhas a 79 caracteres. + - Separe blocos lógicos de código com uma linha em branco. + +4. **Tipagem:** + - Use tipagem estática (`type hints`) conforme descrito no [PEP 484](https://www.python.org/dev/peps/pep-0484/). + - Verifique o uso de tipagem com `mypy`. + +### Boas Práticas e Recomendações + +1. **Modularização:** + - Separe o código em módulos e pacotes de forma a manter as responsabilidades bem definidas. + - Reutilize código sempre que possível, evitando duplicação. + +2. **Testes:** + - Escreva testes unitários para novas funcionalidades e correções de bugs. + - Utilize `pytest` para automação dos testes. + - Busque alcançar uma cobertura de testes superior a 90%. + +3. **Controle de Versão:** + - Faça commits frequentes e com mensagens descritivas. + - Utilize branches para desenvolvimento de novas features ou correção de bugs, seguindo o fluxo [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/). + +4. **Automação:** + - Utilize GitHub Actions para automatizar tarefas de CI/CD, incluindo testes e verificação de qualidade de código. + +## Estrutura do Repositório + +### Descrição da Estrutura de Pastas e Arquivos + +O repositório é organizado da seguinte maneira: + +```plaintext +project-root/ +│ +├── data/ # Armazena arquivos de dados brutos e processados +│ ├── raw/ # Dados brutos coletados diretamente das fontes +│ └── processed/ # Dados já manipulados e prontos para análise +│ +├── scripts/ # Scripts Python para coleta e processamento de dados +│ ├── collect.py # Script principal de coleta de dados +│ ├── process.py # Script principal de processamento de dados +│ └── utils.py # Funções auxiliares usadas nos scripts principais +│ +├── analysis/ # Notebooks Jupyter e scripts para análise de dados +│ ├── analysis.ipynb # Notebook principal para análise exploratória +│ └── visualization.py # Script para geração de gráficos e visualizações +│ +├── docs/ # Documentação do projeto +│ └── index.md # Página inicial da documentação +│ +├── .github/ # Configurações para GitHub Actions e templates de issues +│ ├── workflows/ # Fluxos de trabalho para CI/CD +│ └── ISSUE_TEMPLATE/ # Modelos para criação de issues +│ +├── tests/ # Testes unitários e de integração +│ ├── test_collect.py # Testes para o script de coleta de dados +│ └── test_process.py # Testes para o script de processamento de dados +│ +├── requirements.txt # Lista de dependências do projeto +└── README.md # Descrição geral do projeto From c17b1fef54f6d626351643dd56c8db652c75d5a9 Mon Sep 17 00:00:00 2001 From: PedroLock Date: Mon, 19 Aug 2024 16:26:54 -0300 Subject: [PATCH 2/4] mantenabilidade e desenvolvimento --- docs/Desenvolvimento.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Desenvolvimento.md b/docs/Desenvolvimento.md index 5ff2647..5e1f6a5 100644 --- a/docs/Desenvolvimento.md +++ b/docs/Desenvolvimento.md @@ -1,3 +1,5 @@ + + import os # Define o caminho do diretório 'docs' onde a página será criada From ea8e1e1c637096ba9b75deccca7bd671c631e886 Mon Sep 17 00:00:00 2001 From: PedroLock Date: Mon, 19 Aug 2024 16:59:30 -0300 Subject: [PATCH 3/4] mantenabilidade e desenvolvimento --- docs/Desenvolvimento.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/Desenvolvimento.md b/docs/Desenvolvimento.md index 5e1f6a5..6254758 100644 --- a/docs/Desenvolvimento.md +++ b/docs/Desenvolvimento.md @@ -1,12 +1,9 @@ - -import os - -# Define o caminho do diretório 'docs' onde a página será criada +# Definir o diretório da documentação e o nome do arquivo da nova página docs_dir = "docs" page_filename = "mantenabilidade_desenvolvimento.md" -# Cria o conteúdo da página +# Conteúdo da nova página page_content = """ # Mantenabilidade e Desenvolvimento @@ -21,16 +18,16 @@ Esta página fornece diretrizes de codificação e uma visão geral da estrutura - Siga o padrão `snake_case` para nomes de variáveis e funções em Python e `CamelCase` para nomes de classes. 2. **Documentação:** - - Todos os módulos, classes e funções devem ser documentados com docstrings que seguem o padrão do [PEP 257](https://www.python.org/dev/peps/pep-0257/). - - Adicione comentários esclarecendo blocos de código complexos ou decisões importantes. + - Documente todos os módulos, classes e funções com docstrings que seguem o padrão do PEP 257. + - Adicione comentários para esclarecer blocos de código complexos ou decisões importantes. 3. **Formatação:** - - Utilize `black` como formatador de código para garantir consistência. + - Utilize `black` como formatador de código para garantir a consistência. - Limite o comprimento das linhas a 79 caracteres. - Separe blocos lógicos de código com uma linha em branco. 4. **Tipagem:** - - Use tipagem estática (`type hints`) conforme descrito no [PEP 484](https://www.python.org/dev/peps/pep-0484/). + - Utilize tipagem estática (`type hints`) conforme o PEP 484. - Verifique o uso de tipagem com `mypy`. ### Boas Práticas e Recomendações @@ -46,7 +43,7 @@ Esta página fornece diretrizes de codificação e uma visão geral da estrutura 3. **Controle de Versão:** - Faça commits frequentes e com mensagens descritivas. - - Utilize branches para desenvolvimento de novas features ou correção de bugs, seguindo o fluxo [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/). + - Utilize branches para desenvolvimento de novas funcionalidades ou correção de bugs, seguindo o fluxo Git Flow. 4. **Automação:** - Utilize GitHub Actions para automatizar tarefas de CI/CD, incluindo testes e verificação de qualidade de código. From f3482aabd644ab0fc7a19919d2a607d6e26272cf Mon Sep 17 00:00:00 2001 From: PedroLock Date: Mon, 19 Aug 2024 17:28:20 -0300 Subject: [PATCH 4/4] mantenabilidade e desenvolvimento --- docs/Desenvolvimento.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/Desenvolvimento.md b/docs/Desenvolvimento.md index 6254758..c7a2741 100644 --- a/docs/Desenvolvimento.md +++ b/docs/Desenvolvimento.md @@ -1,10 +1,4 @@ -# Definir o diretório da documentação e o nome do arquivo da nova página -docs_dir = "docs" -page_filename = "mantenabilidade_desenvolvimento.md" - -# Conteúdo da nova página -page_content = """ # Mantenabilidade e Desenvolvimento Esta página fornece diretrizes de codificação e uma visão geral da estrutura do repositório para garantir a qualidade, a consistência e a mantenabilidade do código ao longo do desenvolvimento do projeto.