Objetivos desse guia

Conceitos Básicos

• A documentação está organizada nos seguintes tópicos principais:
• Informações sobre a estrutura organizacional e responsabilidades das diretorias do CIS-IEEE.
• Documentação sobre os processos operacionais e fluxos de trabalho.
• Detalhes sobre os projetos em andamento e concluídos.
• Recursos e documentação relacionados à área de Engenharia de Dados.
• Guias e documentação sobre análise e visualização de dados.
• Recursos e documentação sobre projetos e implementações de Machine Learning.

Recursos

Ferramentas, bibliotecas e recursos úteis para o desenvolvimento.

Este é um repositório de documentação com o objetivo de concentrar todo o conhecimento de _______.

Como trabalhar na wiki

1 - Clone o Projeto para sua máquina

git clone https://github.com/caefleury/cis-ieee-docs.git

2 - Instale o retypeapp

+++ npm

npm install retypeapp --global

+++ yarn

yarn global add retypeapp

+++ dotnet

dotnet tool install retypeapp --global

3 - Entre em uma das pastas e rode o projeto

Essa documentação está dividida em seções principais:

• análise-de-dados
• engenharia-de-dados
• machine-learning
• operações
• projetos
• recursos

Cada seção destas é uma pasta na raiz do repositório e também é um projeto do Retype. Portanto, entre na pasta que você deseja realizar sua documentação e rode o projeto.

cd doc1
retype start

Com o projeto rodando, você pode agora escrever sua documentação em arquivos markdown, com componentes e padrões do Retype.

Para dúvidas sobre como escrever a documentação, acesse a documentação do retype.

Como se organizar no projeto

Crie sua branch e nomeie-a de forma adequada

Para adição de conteúdo à documentação, você pode especificar que sua branch foca no desenvolvimento de uma feature. Por exemplo, para a adição de documentação sobre alterações feitas no banco, você pode nomear sua branch de:

feat/diretorias-projetos Para correção de algo na documentação, você pode agora especificar que sua branch foca em uma fix. Por exemplo, para correção da documentação de typescript, você pode nomear sua branch de: fix/recursos-python

Padrão de commits

Os commits seguem o padrão dos Conventional Commits. Um commit feito para a issue de feat/deploy-banco pode ser feito da seguinte forma:

feat(diretorias): [comentário do que foi feito]

Para correção de algo na documentação, você pode agora especificar que sua branch foca em uma fix. Por exemplo, para correção da documentação de typescript, você pode nomear sua branch de:

fix(recursos): [comentário do que foi feito]

Crie uma PR com o nome da sua branch e elabore uma descrição explicativa

Finalizado o desenvolvimento, você pode agora criar uma PR (Pull Request) no GitHub com o nome da sua branch.

Elabore uma descrição da sua PR, apontando o que foi feito/corrigido, o que faltou fazer (e o por que não fez) e o que pode melhorar.

Por fim, solicite alguém para revisar sua PR.

Aplicadas as revisões, faça o merge com a main.