Treinamento DCPPN

A equipe da Assessoria de Inteligência de Dados (AID) acredita que o compartilhamento de conhecimento é central para que o desenvolvimento e consolidação de melhorias se tornem uma realidade nas mais diversas equipes e organizações.

Nesse sentido, a AID e a Diretora Central de Planejamento, Programação e Normas (DCPPN) está empenhada em uma sequência de reuniões para tratar de temas como filosofia Doc as Code, Git, GitHub, Markdown, dentre outros.

Acompanhe os encontros abaixo:

1º encontro

O que foi tratado nesse encontro

• Apresentação da Filosofia Docs as Code
• Apresentação das ferramentas Git e GitHub
• Criação de Conta no GitHub
• Inclusão de membros na organização Splor
• Criação de repositórios
• Edição do projeto usando o Codespace

2º encontro

O que foi tratado nesse encontro

Como incluir um novo post no blog do Handbook

• Criar issue no repositório (Handbook)
• Abrir Codespace e realizar setup do projeto
• Criar nova branch: git checkout -b <nome da nova branch>
• Editar arquivo Authors
• Incluir post no blog do handbook
• Ligar o servidor e conferir alterações: poetry run mkdocs serve
• Enviar alterações para o repositótio: git commit + git push origin <nome da branch criada>
• Abrir Pull Request e colocar @raianecardoso como revisora

Informações de Setup do Repositório

Considerando que utilizamos o poetry para gerenciar as dependências do projeto, é necessário instalar a ferramenta, via terminal, com o auxílio do pipx, que é um gerenciador de pacotes.

• Instalar pipx: official pipx installation instructions

  sudo apt update
  sudo apt install pipx
  pipx ensurepath
  

• Instalar Poetry: official poetry installation instructions

  pipx install poetry
  

• Após a instalação do Poetry, Instalar das dependências do projeto:

  poetry install
  

• Ligar o servidor local

  poetry run task serve
  

3º encontro

O terceiro encontro não foi gravado, pois se tratou de uma sessão de tira dúvidas.

4º encontro

O que foi tratado nesse encontro

Como o Git funciona:

• Iniciar repositório em uma pasta com git init
• Alterações com git status
• Realizar commits com git add [nome doc alterado] ou git add + git commit
• mostrar a mágica do git reset --hard <ID do commit>
• mostrar fluxo de trabalho: git status + git pull origin <branch name>+ git add + git commit + git push origin <nome da branch>

Alteração de um post no handbook com vídeo

• Incluir vídeo no YouTube
• Preparar texto resumo com o GPT em markdown
• Abrir o repositório usando Codespaces
• Abrir nova branch: git checkout -b <nome da nova branch>
• Alterar post
• Commitar mudanças: git add [nome doc alterado] ou git add + git commit
• Enviar alterações para o repositório: git push origin <nome da branch criada>
• Abrir PR no GitHub

5º encontro

O quinto encontro não foi gravado, pois foi foram feitas as mesmas atividades do 4º encontro na intenção de fixar as etapas do processo de trabalho.

6º encontro

O que foi tratado nesse encontro

• O que é o pull request

Um pull request (ou solicitação de pull) é uma proposta para integrar as mudanças de uma branch em outra, sendo realizada uma revisão antes de mesclar as alterações na branch principal de um projeto (geralmente, chamada main). Em outras palavras, é uma forma de um membro da equipe notificar que terminou de trabalhar em uma nova funcionalidade, documentação ou correção e está pronto para que o seu trabalho seja integrado ao projeto principal

• Como realizar a revisão de um pull request e resolver conflitos.

Um conflito em um pull request ocorre quando o sistema de controle de versão, no caso o Git, não consegue mesclar automaticamente as alterações de duas branches diferentes devido a alterações conflitantes nos mesmos arquivos ou linhas de código. Isso geralmente acontece quando duas ou mais pessoas trabalham no mesmo trecho de código simultaneamente. Como resolver conflitos?

• Abrir a pull request e identificar os arquivos com conflitos: O git indica quais arquivos precisam ser resolvidos.

• Abrir o arquivo com conflito e examinar as marcações: Você verá as áreas com conflitos, indicando as versões de código de cada branch. Os marcadores especiais são: <<<<<<<, =======, e >>>>>>>.

• Escolher qual versão manter ou mesclar as alterações: Você pode escolher manter a versão de uma das branches, mesclar as alterações manualmente, ou remover partes de ambos os códigos para criar uma nova versão.

• Remover os marcadores de conflito: Depois de resolver o conflito, você deve remover os marcadores do código.

• Fazer commit das alterações e atualizar a pull request: Após resolver todos os conflitos, você pode fazer commit das alterações e concluir a mesclagem.

Comentários