Documentação de Desenvolvimento

Materiais relacionados a Git, GitLab, GitFlow, Docker e fluxo de desenvolvimento, organizados para servir tanto como introdução às ferramentas quanto como referência para as atividades do dia a dia.

Git, GitLab e Organização do fluxo de desenvolvimento

• [DEV] Versionamento de Projetos de Software - Adicionando um projeto ao GitLab
  Introdução ao versionamento: apresenta como adicionar um projeto existente ao Git e posteriormente disponibilizá-lo em um repositório do GitLab.
• [DEV] Git - Comandos básicos para fazer uso da tecnologia
  Conceitos fundamentais do Git: explica com maior profundidade os principais conceitos e comandos do Git, servindo como material de consulta para compreender o funcionamento da ferramenta.
• [DEV] GitFlow - Como utilizar o Git de maneira organizada e garantir um versionamento sustentável
  Organização do desenvolvimento: apresenta o GitFlow adotado pela empresa, explicando o propósito das branches e como utilizá-las para manter um fluxo de versionamento organizado e sustentável.
• [DEV] GitLab - Convenção de nomenclatura de issues para facilitar rastreabilidade de tarefas com o suporte.midiaticloud
  Rastreabilidade de tarefas: define a convenção de nomenclatura das issues no GitLab para facilitar a identificação e o acompanhamento das solicitações relacionadas ao suporte.
• [DEV] Padronização dos Boards de Desenvolvimento no GitLab
  Organização dos Boards: explica como criar e organizar os Boards de desenvolvimento no GitLab e qual é a finalidade de cada Board dentro do fluxo de trabalho.

Workflows de Projetos da Empresa - Docker e ambientes de Desenvolvimento 

• [DEV] Trabalhando com Docker e GitLab - Recuperando o sistema dos repositórios remotos e subindo o sistema localmente
  ⚠️ Material legado: apresenta como recuperar o projeto dos repositórios remotos e executá-lo localmente utilizando Docker. As informações foram posteriormente incorporadas e atualizadas em uma documentação mais recente.
• [DEV] Criando Dockerfiles e Docker Compose para subir um projeto PHP Web (Zend Framework 1 - ZF1)
  Containerização de projetos PHP: ensina a criar os arquivos Dockerfile e docker-compose necessários para executar um projeto PHP baseado em Zend Framework 1.
• [DEV] Fluxo de Trabalho com OpenCart - GitLab + FileZilla
  Fluxo de desenvolvimento do OpenCart: apresenta o processo utilizado para desenvolver, versionar e disponibilizar alterações no projeto OpenCart utilizando GitLab e FileZilla. Este material substitui a documentação anterior sobre recuperação e execução do sistema.

Projeto prático de Git e GitFlow

Projeto MIDIATI Git Tutorial - GitLab

Aprendizado prático: projeto desenvolvido etapa a etapa para demonstrar, na prática, o uso do Git, GitLab e GitFlow, acompanhando a evolução do sistema branch por branch e simulando situações reais de desenvolvimento.

A versão mais atualizada encontra-se na branch dev.

O projeto também possui uma documentação complementar bastante detalhada:

documentation/
├── commits/
├── git-tips/
├── 00-introduction.md
├── 01-project_structure.md
├── ...

documentation/

Contém a documentação geral do projeto, sua estrutura e os procedimentos utilizados durante seu desenvolvimento.

documentation/commits/

Contém a documentação etapa por etapa, descrevendo as tarefas realizadas em cada branch, permitindo acompanhar como o projeto foi construído e como cada alteração se relaciona com o fluxo do GitFlow.

documentation/git-tips/

Contém exemplos de situações comuns e inconvenientes do Git, apresentando como identificar e resolver problemas como:

• esquecer de trocar de branch;
• não conseguir trocar de branch;
• realizar um commit na branch errada;
• iniciar uma branch a partir de uma dev desatualizada;
• resolver conflitos de merge;