Skip to content

Latest commit

 

History

History
392 lines (248 loc) · 21.1 KB

tarefa1.md

File metadata and controls

392 lines (248 loc) · 21.1 KB
Raw

Tarefa 1: Praticando na Solidão

Agora é a hora de começarmos a contribiuir!

1. Crie uma Conta no GitHub 📝

Se você ainda não tem uma conta no GitHub, o primeiro passo é criar uma. O GitHub é a plataforma que usamos para gerenciar nosso repositório e facilita a colaboração entre desenvolvedores. Siga o passo a passo para a criação da conta:

2. Instale o Git 💻

Para poder colaborar com o código do projeto, você vai precisar do Git, um sistema de controle de versão que nos ajuda a gerenciar o histórico de mudanças no código. Se você ainda não tm o Git instalado, siga esses passos:

3. Faça um Fork do Projeto 🍴

3.1 Fork? Que? 🤔

Um fork é uma cópia completa de um projeto que você faz a partir do repositório original, hospedado em plataformas como o GitHub. Ele é extremamente útil, especialmente para iniciantes, pois permite que você trabalhe em uma versão separada do projeto sem afetar o repositório original.

Imagine que você quer fazer um bolo seguindo a receita de um amigo, mas você quer adicionar seus próprios toques, como colocar mais cobertura ou mudar o sabor. Ao invés de mexer na receita original do seu amigo, você faz uma cópia da receita para si. Agora você pode experimentar à vontade, fazendo ajustes e melhorias no seu próprio tempo, sem medo de estragar a receita original.

Esse processo é exatamente o que acontece quando você faz um fork de um repositório no GitHub. O fork é como essa cópia da receita. Você pega todo o código do projeto original e o coloca na sua própria "cozinha" (ou repositório), onde pode fazer as modificações que quiser. O repositório original não é afetado pelas suas mudanças.

Se você achar que suas alterações deixaram o bolo ainda mais gostoso (ou seja, se você fez uma melhoria no código), você pode sugerir que o dono da receita original (o mantenedor do projeto) incorpore essas mudanças, enviando um pull request. Eles podem revisar o que você fez e, se acharem válido, integrar suas melhorias no projeto original.

Dessa forma, você pode colaborar em projetos abertos, experimentando e aprendendo sem risco de afetar a base de código principal, e ainda pode contribuir de volta se as suas mudanças forem úteis!

3.2 Principais Usos de um Fork 💡

Testar e experimentar: Você pode modificar o código à vontade, testar novas ideias ou corrigir problemas sem se preocupar em estragar o projeto original.

Contribuir com melhorias: Quando estiver satisfeito com suas mudanças, você pode criar um pull request para sugerir essas modificações ao repositório original, permitindo que outros usuários se beneficiem delas.

Aprender com projetos existentes: O fork é uma ótima maneira de aprender, pois você pode examinar o código de outros, entender como ele funciona e, aos poucos, fazer suas próprias melhorias ou adaptações.

No contexto do GitCaos, você fará um fork para criar sua própria versão do projeto, fazer alterações, e depois contribuir de volta com as melhorias que você fez. Esse processo é essencial para o desenvolvimento colaborativo no mundo open source.

3.3 Instruções para fazer um fork 🔨

No GitHub, um fork cria uma cópia do projeto na sua conta. Isso permite que você faça alterações no código sem modificar diretamente o repositório original. Quando suas mudanças estiverem prontas, você poderá enviá-las de volta ao repositório original (mais sobre isso depois).

  1. Acesse o Repositório Original:

  2. Crie o Fork:

    • Clique no botão Fork no canto superior direito da página.
    • Isso cria uma cópia do repositório na sua conta do GitHub, que terá o formato seu-username/gitcaos. Ex: https://github.com/camilamaia/gitcaos

  3. Verifique Seu Fork:

    • Após fazer o fork, você pode acessar sua versão copiada do projeto em github.com/seu-username/gitcaos, onde seu-username é o seu nome de usuário no GitHub.

3.4 Repositório Original vs. Seu Fork 🆚

Repositório Original (cumbucadev/gitcaos):

  • Contém issues (problemas relatados), pull requests (contribuições sugeridas por outros colaboradores), e toda a história do projeto.
  • É a versão principal que todos estão utilizando como referência.

Seu Fork (seu-username/gitcaos):

  • É uma cópia onde você pode modificar o código à vontade, testar novas ideias e fazer melhorias sem afetar o repositório original.
  • Não contém as mesmas issues ou pull requests que o original, pois é uma versão separada e independente.

⚠️ Dica Importante: Sempre verifique o caminho no topo da página do GitHub para garantir que você está trabalhando no repositório correto. O caminho deve indicar seu nome de usuário e o nome do repositório (seu-username/gitcaos), e não cumbucadev/gitcaos, que é o repositório original.

Essa estrutura de forks permite que você colabore em projetos open source de maneira segura e organizada, aprendendo enquanto contribui!

Para mais detalhes sobre forks no GitHub:

4. Clone o Seu Fork 🐏

4.1 Clonar? Que? 🤔

Clonar um repositório significa criar uma cópia local do código do seu fork em seu computador. Isso permite que você trabalhe no projeto de maneira offline e faça modificações no seu ambiente de desenvolvimento preferido.

Pense nisso como se você estivesse baixando a receita do bolo que você personalizou (seu fork) para a sua cozinha, onde pode mexer e experimentar à vontade, longe da cozinha original (o repositório original).

4.2 Por que Clonar seu Fork? 🧐

Clonar seu fork é fundamental porque:

  • Trabalho Local: Você pode desenvolver e testar seu código no seu próprio computador, o que pode ser mais rápido e conveniente.
  • Controle Total: Você tem total controle sobre suas mudanças e pode testar suas ideias sem impactar o repositório original ou até mesmo seu próprio fork até que esteja pronto.
  • Facilidade de Uso: Ferramentas de desenvolvimento como IDEs (Ambientes de Desenvolvimento Integrados) podem ser usadas para facilitar o desenvolvimento. Ex: Visual Code Studio, PyCharm...

4.3 Instruções para Clonar Seu Fork 📖

Siga estas etapas simples para clonar seu fork do repositório GitCaos:

  1. Acesse seu Fork:

    • Vá para a sua conta do GitHub e encontre o repositório que você criou a partir do fork (seu-username/gitcaos).

  2. Copie a URL do Fork:

    • Na página do seu fork, clique no botão verde Code e copie a URL fornecida. Você pode escolher entre usar HTTPS ou SSH, dependendo de como está configurado seu Git.

  3. Abra o Terminal:

    • No seu computador, abra o terminal (ou o prompt de comando).

  4. Navegue até o Local Desejado:

    • Use o comando cd para navegar até a pasta onde você deseja armazenar o projeto clonado.

  5. Clone o Repositório:

    • Execute o seguinte comando, substituindo a URL pela que você copiou:

      git clone https://github.com/seu-username/gitcaos.git

    • Ou, se você estiver usando SSH:

      git clone [email protected]:seu-username/gitcaos.git

  6. Acesse a Pasta do Projeto:

    • Após o clone ser concluído, entre na pasta do projeto:

      cd gitcaos

Agora você tem uma cópia local do seu fork e pode começar a trabalhar nas suas melhorias e modificações! 🌟

Com isso, você está pronto para começar a explorar e desenvolver no seu próprio fork do GitCaos!

Para mais informações sobre como clonar repositórios no GitHub, você pode consultar:

5. Encontre uma Issue para Trabalhar 🔍

Agora é hora de encontrar uma issue (tarefa ou problema) para trabalhar. Esse é um passo importante e comum no mundo do open source, onde colaboramos para melhorar projetos e aprender juntos. No GitCaos 🔥, usamos as issues para organizar as atividades do projeto. Isso pode incluir corrigir bugs, adicionar novas funcionalidades e melhorar a documentação.

Siga estas etapas simples para encontrar sua primeira issue:

  1. Acesse o Repositório: Navegue até a página principal do projeto no GitHub: https://github.com/cumbucadev/gitcaos
  2. Na parte superior da página do repositório principal, você verá várias abas. Clique na aba chamada Issues. Aqui, você encontrará uma lista de tarefas disponíveis que precisam de ajuda.
  3. Procure pela issue específica: Agora, você precisa encontrar uma issue com o título: Tarefa 1: Criar arquivo: seu-username.txt. Essa tarefa foi criada especialmente para você, e é uma ótima oportunidade para praticar.
  4. Verifique se a issue já está designada para alguém: Olhe ao lado do título da issue para ver se ela já tem alguém designado (chamado de assignee). Se o seu nome já estiver lá, ótimo! Isso significa que você está pronto para trabalhar na tarefa. Se não estiver, você pode pedir para ser designado. Para isso, deixe um comentário na issue dizendo algo como: "Oi, eu gostaria de trabalhar nessa tarefa! Você pode me designar?". Isso garante que nunca mais de uma pessoa trabalhe na mesma issue, evitando conflitos e confusões no desenvolvimento.
  5. Leia atentamente as instruções: Antes de começar a trabalhar, é fundamental ler todas as instruções que estão na issue. Isso vai garantir que você entenda o que é solicitado e que siga as diretrizes corretamente. Preste atenção a detalhes como formato de arquivo, informações que devem ser incluídas e qualquer outro requisito.

Importante: Quando você fez o fork do repositório, isso criou automaticamente uma issue para você. Essa é uma forma didática de ajudar novos colaboradores a encontrar uma tarefa prática e se familiarizar com o processo. Normalmente, você encontrará outras tarefas disponíveis que também precisarão de ajuda.

6. Crie um Novo Branch 🎋

Antes de começar a trabalhar nas suas alterações, você precisa criar um novo branch. Um branch é uma linha de desenvolvimento independente, onde você pode fazer mudanças sem afetar o código que está na branch principal (geralmente chamada de main ou master).

  1. Abra o terminal no seu computador.

  2. Navegue até a pasta do seu projeto GitCaos. Use o comando cd caminho/do/seu/projeto para acessar a pasta correta.

  3. Verifique o estado atual do seu repositório com o comando:

    git status

    Você verá algo como:

    On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean

  4. Identifique o número da issue. Como você já tem o link da issue, o número estará no final da URL. Por exemplo, se a URL da issue for https://github.com/cumbucadev/gitcaos/issues/12, o número da issue é 12.

  5. Crie um novo branch usando apenas o número da issue:

    git checkout -b 12

  6. Verifique o estado do repositório após a criação do branch com:

    git status

    O resultado deve ser semelhante a:

    On branch 12
Switched to a new branch '12'

nothing to commit, working tree clean

7. Faça suas Alterações 🔨

Agora que você está no seu novo branch, é hora de fazer as alterações necessárias no código ou na documentação. As alterações devem ser feitas seguindo as instruções que estão especificadas na issue que você está resolvendo.

  1. Abra o projeto em um editor de texto ou IDE.
  2. Siga as instruções da issue.

Após realizar as modificações, você pode continuar para o próximo passo.

8. Adicione suas Alterações ➕

Depois de fazer as alterações, você precisa adicioná-las ao seu branch. Isso informa ao Git quais alterações você deseja incluir no próximo commit.

  1. Verifique o estado do seu repositório com:

    git status

    O resultado mostrará que o arquivo foi modificado, algo como:

    On branch 12
Changes not staged for commit:
modified:   seu-username.txt

  2. Adicione suas alterações usando o comando:

    git add caos/@seu-username/seu-username.txt

  3. Verifique novamente o estado do repositório com:

    git status

    O resultado agora mostrará que o arquivo foi adicionado:

     On branch 12
 Untracked files:
   (use "git add <file>..." to include in what will be committed)
         caos/@seu-username/

9. Faça um Commit de suas Alterações ✅

Agora é hora de salvar suas alterações no histórico do Git. Para isso, você deve "commitar" suas alterações.

9.1 Commit? Que? 🤔

Um commit é como uma fotografia do seu código em um determinado momento. Quando você faz um commit, você está criando um registro das alterações que fez, que pode incluir novos arquivos, modificações em arquivos existentes ou a exclusão de arquivos. Cada commit tem uma mensagem que descreve o que foi alterado, permitindo que outros colaboradores entendam rapidamente as mudanças que você fez e o motivo delas.

Os commits são fundamentais para o versionamento, pois permitem que você:

  • Volte no tempo: Se algo der errado, você pode retornar a uma versão anterior do seu projeto.
  • Entenda a evolução do projeto: Você pode ver como o código mudou ao longo do tempo, facilitando a identificação de quando e por que alterações específicas foram feitas.
  • Colabore efetivamente: Outros desenvolvedores podem revisar suas mudanças, fazer sugestões e integrar suas contribuições ao projeto.

9.2 Faça um Commit 🔨

  1. Realize o commit com o seguinte comando: (Substitua seu-username pelo seu nome de usuário do GitHub. Essa mensagem ajuda outros a entenderem rapidamente o que foi alterado.)

    git commit -m "Novo arquivo: seu-username.txt"

Depois de realizar o commit, suas alterações estão salvas no histórico do Git, prontas para serem enviadas para o seu repositório no GitHub.

10. Faça um Push de suas Alterações 🤞

Depois de realizar o commit das suas alterações, é hora de enviá-las para o repositório remoto no GitHub. Esse processo é chamado de push.

10.1 Push? Que? 🤔

O push é o ato de enviar suas alterações do seu repositório local (no seu computador) para o repositório remoto (no GitHub). Pense no seu repositório local como um caderno onde você faz anotações e, quando você faz um push, é como se estivesse enviando essas anotações para um mural público onde todos podem ver.

10.2 Faça um Push 🔨

  1. Abra o terminal (ou o prompt de comando).

  2. Navegue até o diretório do seu projeto se você ainda não estiver lá:

    cd caminho/para/seu/projeto

  3. Execute o comando de push para o branch específico (substitua 12 pelo nome do branch que você criou):

    git push origin 12

Aqui está o que cada parte desse comando significa:

  • git push: Este é o comando que diz ao Git que você deseja enviar suas alterações.
  • origin: Refere-se ao seu repositório remoto (o GitHub).
  • 12: É o nome do branch onde suas alterações estão.

10.3 Por que Fazer um Push? ❓

  • Colaboração: Permite que outros membros da equipe vejam e revisem suas alterações. Isso é crucial em projetos em grupo.

  • Backup: Armazenar suas alterações na nuvem protege seu trabalho de possíveis problemas no seu computador.

  • Histórico: O push mantém um registro da evolução do projeto, facilitando a consulta e a compreensão das mudanças ao longo do tempo.

Após executar o comando de push, suas alterações estarão disponíveis no GitHub no branch 12. Outros colaboradores poderão revisar suas alterações e, eventualmente, integrar suas contribuições ao código principal.

Resumo:

  • Local: Seu computador (onde você faz alterações).
  • Remoto: GitHub (onde você armazena e compartilha seu código).
  • Push: O ato de enviar suas alterações para o GitHub.

Para mais informações sobre push, você pode consultar:

11. Crie um Pull Request (PR) no GitHub 💬

Após fazer o commit, você precisa criar um Pull Request (PR) para que suas alterações possam ser revisadas e eventualmente mescladas à branch principal. Lembre-se de que você deve fazer isso no seu fork do repositório GitCaos.

  1. Acesse o GitHub e vá até o seu repositório forkado do GitCaos.

  2. Localize o branch que você acabou de criar. Você verá uma opção para criar um Pull Request.

  3. Clique em "Compare & pull request".

  4. Preencha o título e a descrição do PR:

    • Título: "Tarefa 1: seu-username.txt" (substitua seu-username pelo seu nome de usuário).

    • Descrição: (Substitua 12 pelo número da issue que você está resolvendo, que pode ser encontrado no final da URL da issue.)

      Tarefa 1:
- Arquivo seu-username.txt adicionado

Closes #12

  5. Clique em "Create pull request" para finalizar.

Pronto! Agora sua contribuição será revisada por outros colaboradores do projeto GitCaos.

O Quê Acontece Agora? 🙋

Parabéns! Você chegou até aqui e completou sua contribuição inicial para o projeto GitCaos! Agora, é hora de esperar as revisões.

  1. Revisão: Outros colaboradores do projeto irão revisar suas alterações. Eles vão verificar se tudo está correto e se as mudanças atendem às instruções da issue.

  2. Mudanças: Se necessário, eles podem pedir para você fazer ajustes ou melhorias. Isso é parte do processo colaborativo e ajuda a garantir a qualidade do projeto.

  3. Merge: Se suas alterações estiverem boas, um colaborador com permissão irá mesclar (merge) seu Pull Request ao branch principal do projeto. Isso significa que suas contribuições farão parte do projeto GitCaos 🔥!

  4. Fechamento da Tarefa: Quando o Pull Request for mesclado, a tarefa associada à issue será automaticamente marcada como "closed". Isso acontece porque você incluiu na descrição do Pull Request a frase Closes #numero-da-issue. Essa frase informa ao sistema que a tarefa deve ser fechada automaticamente quando as alterações forem integradas.

Próximos Passos 👀

  • Aguarde as Revisões: Verifique seu Pull Request regularmente para ver se há comentários ou solicitações de mudanças.

  • Trabalhe na Próxima Tarefa: Enquanto espera as revisões da sua primeira tarefa, você pode começar a trabalhar na segunda tarefa! No entanto, não se esqueça de verificar as revisões, pois a tarefa só é concluída de fato quando há a mesclagem e a tarefa é marcada como fechada.

  • Responda a Comentários: Se os revisores deixarem feedback, responda prontamente e faça as alterações necessárias.

  • Fique Atento: Acompanhe a mesclagem do seu Pull Request para saber quando sua tarefa foi oficialmente concluída.

Esse processo é fundamental para garantir que o projeto se mantenha organizado e funcional, permitindo que todos os colaboradores participem e aprendam uns com os outros.

Parabéns mais uma vez por sua primeira contribuição open source! 🎉

Ações: