Parabéns! Você foi contratado como desenvolvedor júnior na Campinho Digital. Agora é hora de iniciar suas contribuições no repositório da empresa. Seu primeiro passo será enviar um e-mail solicitando acesso ao repositório, depois clonar o projeto e realizar suas primeiras contribuições.
Aqui estão as etapas detalhadas que você deve seguir para começar a contribuir com o repositório colaborativo da Campinho Digital, praticando conceitos como criação de branches, commits, pull requests, e merge.
Essa atividade tem como objetivo familiarizar os participantes com o fluxo de trabalho colaborativo no Git, utilizando comandos como git branch, git checkout, git merge, além de criar, editar e resolver conflitos em branches separadas. Os alunos irão aprender a contribuir em um repositório Git colaborativo, criar branches, realizar commits e enviar suas alterações para o repositório remoto.
O primeiro passo para começar a trabalhar com o repositório da empresa é solicitar o acesso.
Para contruibuir com o projeto Campinho Digitalé importante conhecer o markdown
Markdown é uma linguagem de marcação leve que permite que você escreva conteúdo formatado de maneira simples e intuitiva. Você pode escrever cabeçalhos, listas, links e muito mais de forma rápida, e o resultado pode ser convertido em HTML ou outros formatos.
Simplicidade: Fácil de ler e escrever. Formato Texto Plano: Arquivos .md podem ser editados em qualquer editor de texto. Conversão Simples: Convertido facilmente para HTML ou PDF. Você pode consultar este guia para aprender mais sobre Markdown.
Pré-requisito: Tenha o Git instalado no seu computador. Editor sugerido: Recomendo o uso do VSCode para edição de código e execução de comandos Git, ou o terminal, caso prefira.
O repositório onde vocês irão colaborar está disponível no GitHub. Primeiro, você deve clonar esse repositório no seu ambiente local.
Acesse o repositório no GitHub.
Copie o link SSH
No terminal, rode o comando abaixo para clonar o repositório:
git clone <URL_DO_REPOSITORIO>Navegue até a pasta do repositório:
cd nome_do_repositorio
Para garantir um fluxo de trabalho colaborativo eficiente, cada participante deve criar sua própria branch para adicionar contribuições. Isso evita conflitos diretos no branch principal (geralmente chamado de main ou master).
Criar um novo branch para sua contribuição:
Escolha um nome descritivo para sua branch, como minha-contribuicao.
git checkout -b minha-contribuicao
Verifique em qual branch você está:
git branch
Isso exibirá uma lista das branches locais. A branch no qual você está atualmente será marcado com um *.
Agora que você está em uma nova branch, pode fazer alterações no repositório.
├── README.md
└── squads
├── squad1
│ └── seu_nome_sobrenome.md
├── squad2
│ └── seu_nome_sobrenome.md
├── squad3
│ └── seu_nome_sobrenome.md
├── squad4
│ └── seu_nome_sobrenome.md
├── squad5
│ └── seu_nome_sobrenome.md
└── squad6
└── seu_nome_sobrenome.md
- Cada colaborador deve criar um arquivo dentro da pasta correspondente ao squad a que pertence.
- O nome do arquivo deve seguir o padrão nome_sobrenome.md, onde seu primeiro nome e sobrenome são separados por underline (_).
Exemplo: Se o seu nome for João Silva, o nome do arquivo será joao_silva.md.
Cada arquivo de documentação individual deve estar localizado na pasta do squad correto. Por exemplo: Se você faz parte do Squad 3, o seu arquivo nome_sobrenome.md deve estar dentro da pasta squad3.
Estrutura correta para João Silva no Squad 3:
squads
├── squad3
└── joao_silva.md
O arquivo nome_sobrenome.md deve conter as seguintes informações mínimas (Em Markdown):
- Objetivo: Descreva suas responsabilidades e contribuições dentro do squad (Podem ser atruibuições fictícias).
- Responsabilidades: Liste as principais tarefas ou áreas que você está encarregado(a)..
- Contato: Inclua uma forma de contato, como e-mail ou outro canal interno da empresa, para facilitar a comunicação.
- Você pode adicionar mais seções relevantes conforme necessário.
Agora que você fez uma alteração, vamos salvar (commitar) essa mudança no Git.
Adicione os arquivos modificados para o stage:
git add .
Crie um commit com uma mensagem descritiva:
git commit -m "Adicionei minha contribuição no README.md"
A branch main do repositório campinho está protegida. Alterações não podem ser enviadas diretamente para ela via push. Por favor, crie uma nova branch e submeta suas alterações através de um pull request.
Após fazer o commit, você precisa enviar suas alterações para o repositório remoto.
Empurre (push) suas alterações para o GitHub:
git push origin minha-contribuicao
Isso enviará as alterações para o repositório remoto na sua branch criada.
Depois de enviar suas alterações para o GitHub, é hora de criar um Pull Request (PR). Esse é o processo de solicitar que suas alterações sejam mescladas na branch principal (main ou master).
Acesse o repositório no GitHub.
Você verá um botão para criar um novo Pull Request com base na branch que você enviou (minha-contribuicao).
Preencha o título e a descrição da PR, explicando as alterações que você fez.
Envie a PR para revisão.
Se for o proprietário do repositório ou tiver permissões de revisão, siga os seguintes passos:
Acesse a lista de Pull Requests. Revise as mudanças propostas pelos colaboradores. Se as mudanças estiverem adequadas, faça o merge para incorporar as alterações na branch principal. Caso seja necessário, comente sobre melhorias ou faça alterações antes de aceitar.
Se outros colaboradores fizeram mudanças na branch principal enquanto você trabalhava na sua branch, é importante garantir que sua cópia local esteja atualizada. Para isso, siga os passos abaixo:
Troque para a branch principal:
git checkout main
Puxe as mudanças mais recentes do repositório remoto:
git pull origin main
Mergir as alterações recentes na sua branch (caso necessário):
git checkout minha-contribuicao
git merge main
Resolva conflitos, se houver, e commit suas alterações.
git clone: Para clonar o repositório remoto para o ambiente local.
git branch: Para criar e listar branches.
git checkout: Para trocar de branch.
git add: Para adicionar arquivos ao stage.
git commit: Para criar um commit com uma mensagem descritiva.
git push: Para enviar suas alterações para o repositório remoto.
git pull: Para obter as alterações mais recentes do repositório remoto.
Pull Request (PR): Para solicitar que suas alterações sejam mescladas à branch principal.
Caso você esteja enfrentando erros ao tentar fazer push, pode ser que o seu repositório local não esteja sincronizado com o remoto. Tente executar git pull para atualizar seu repositório local antes de enviar suas alterações
Resolução de Conflitos: Se dois ou mais contribuidores modificarem a mesma linha de código, um conflito ocorrerá. Pratique a resolução de conflitos quando fizer merge de branches.
Rebase: Experimente o comando git rebase para reordenar commits antes de faz