Skip to content

Como contribuir com a nossa galeria

Beatriz Miranda edited this page Oct 25, 2020 · 1 revision

👶 BabySteps Tutorial: Como Contribuir com a nossa galeria

Olá Baby,

Se você caiu aqui nesse mundo de GIT de paraquedas, temos aqui um pequeno tutorial para você. Comecemos com a contribuição para a pasta Galeria.

Primeira contribuição


Caso seja a sua primeira contribuição, é necessário que entendam primeiro os mecanismos de versionamento do git.



1 - Repositório - lista de arquivos


Nesse espaço estará listado todas as pastas, arquivos, executáveis e assets que o projeto com o qual irá contribuir possui. Aqui, você pode navegar entre pastas, verificar o código-fonte dos arquivos e abrir alguns README.

2 - README.md


Em alguns projetos, os repositórios possuem instruções para o manuseio do projeto. Essas são escritas com a linguagem de marcação Markdown,em um arquivo de pré-visualização de arquitetura git chamado README, com a extensão .md. Neste arquivo, você poderá extrair informações importantes, como o código de conduta, formatação necessária, informações sobre o projeto e a execução.

3 - Botão Fork


Contribuir com um repositório nem sempre quer dizer que você está participando dele. No caso de repositórios abertos no Git, essa é um fato. Para que possa contribuir com o projeto, o botão fork serve para criar uma ¨cópia¨ exata dele no seu githubgithub. A partir daí, já é possível manipular sua cópia sem comprometer o repositório original.

4 - Aba de Pull Request


Como explicado no fork, para contribuir com o repositório, não é necessário que esteja contribuindo com o repositório. Entretanto, a submissão é necessária para a avaliação de algum contribuinte. A partir dos arquivos 'copiados' pelo fork, você irá abrir uma avaliação que aparecerá nesta aba. Para aprender a abrir tal, siga para os próximos passos.

Contribuindo com a Galeria


Já entendido como funciona alguns mecanismos do git, vamos começar a contribuir! Lembrando que talvez você não faça parte da lista de contribuintes, vamos inicializar fazendo o fork dos arquivos do projeto em nosso repositório. Para isso, é necessário que se aperte o botão fork, como descrito na imagem abaixo:


Logo após clicar nesse botãozinho, no seu perfil constará uma cópia do repositório do projeto com o qual queira contribuir. Dessa forma, poderá modificar sem que haja alteração no projeto original. A sua cópia deve aparecer com o link seu-usuario-git/BabySteps , como mostrado na imagem a seguir:


Em seguida, teremos duas opções de como trabalhar com os arquivos: Adicionar e editar diretamente do github ou adicionar e editar arquivos dr maneira local, no seu computador! Para usuários linux, utilizaremos o Terminal, para usuários Windows utilizaremos o prompt de comando (Para os passos seguintesi, será necessário ter o git instalado na máquina).

Iniciaremos fazendo um clone (cópia) dos arquivos para a sua máquina. No seu terminal,irá digitar o seguinte código:

git clone https://github.com/SEU-USUARIO-GIT/BabySteps

O link inserido após o comando git clone é o link da sua cópia do repositório. O comando irá carregar todos os arquivos para a sua máquina. Quando o download for concluído, você poderá abrir o projeto em qualquer IDE de sua preferência. No tutorial, utilizaremos o Visual Code. Após aberto na IDE, iremos trabalhar com os arquivos. Selecionando a pasta galeria, como mostra a imagem.


Na pasta galeria verão arquivos já criados, contando um pouco da história de mulheres incríveis para a computação. Está na hora de ajudar essa galeria a crescercrescer. Vamos adicionar o arquivo com a extensão .md a pasta galeria.


Para ficar bem bacana, a sua contribuição deve ser em linguagem de marcação Markdown. Mas calma! Não é necessário conhecer profundamente a linguagem, suas funções e etc. Você pode se basear em alguns arquivos do projeto, para que tenha base para escrever o próprio. O importante é tentar entender um pouco o que cada código Markdown faz (o que pode ser tema de outro repositório). Feito isso, está na hora de uparmos as modificações para o seu repositório!

Abra o terminal ou o prompt de comando dentro da sua pasta de arquivos do projeto. Após abrir, digite o seguinte comando:

git status

O comando git status irá te mostrar quais arquivos você editou no projeto, a saída do comando deverá ser algo como mostrado na imagem:


Não se assuste com a cor vermelha das letras, está tudo bem, só falta adicionarmos os arquivos para o fluxo de adição. Para isso, vamos utilizar o seguinte comando:
git add *


O comando git add * irá fazer a adição de todos os arquivos modificados no fluxo de adição. Após a inserção do comando, voltaremos a utilizar o git status para verificar se todos os arquivos foram adicionados ao fluxo. A saída do segundo git status deverá ser a seguinte:


Prontinho, tudo verdinho! Porém, nada ainda foi adicionado a sua cópia do repositório. Para isso, vamos confirmar as alterações para o seu repo. Para fazer essa confirmação de preparo de envio, precisamos utilizar o seguinte código:
git commit -m 'algum comentário bacana sobre a sua alteração'
O comando git commit irá confirmar as alterações, o _ -m _ utilizado irá te dispor de um espaço para uma mensagem relacionada ao seu commit. É sempre importante sinalizar com uma mensagem o commit para mostrar aos outros colaboradores o que foi modificado e/ou o porquê foi modificado. A mensagem após o _ -m _ deverá ser escrita entre aspas. Após a entrada desse comando, a saída no terminal deverá ser assim:


Prontinho, agora tudo está pronto para ser upado. Depois do git add e do git commit precisamos ir para o tão esperado upload de modificações! Para fazer o upload, vamos utilizar o seguinte comando:
git push

O comando git push irá 'empurrar' as suas modificações para o seu repositóriorepositório. Para que isso aconteça, precisará inserir seu Username e seu Password para a validação de identidade daquela cópia do projeto que está inserindo as modificações.


Agora sim as suas modificações foram adicionadas a sua cópia do repositório. Porém, como adicionar ao repositório do projeto? A resposta é simples: _ pull request _.

Abrindo o seu Pull Request


Agora que todo o trabalho árduo foi feito, está na hora de adicioná-lo ao repositório principal. Para isso,iremos acessar o Github. No seu perfil do Github, você irá acessar a sua cópia do projeto e verificar se todas as alterações subiram. Notará que terá a modificação em destaque na tela do repositório e lá, contará com seu comentário enviado no git commit, como na imagem a seguir:


Verificado isso, vamos ao que importaimporta: o Pull Request. Nessa mesma tela de repositório,irá notar um aviso semelhante a This branch is 1 commit ahead of elasComputacao:master. e logo a frente, um botão de Pull Request . Ao clicar nesse botão, primeiro estará: comparando as suas modificações da cópia do repositório com o repositório original. Segundo: submetendo a suas alterações à uma avaliação, para ser aceita (ou não) como contribuição. Clicando no Pull Request você irá ser redirecionado para essa página:


A página irá mostrar todas as alterações feitas, o resultado da comparação com o repositório original e te dirá se pode ou não, criar o Pull Request. Caso esteja com o resultado Able to merge clique no botão Create pull request. O git irá te redirecionar para uma página de comentários:


Adicionado um comentário bacana, você pode clicar no botão Create pull request ,como mostrado acima, e está feito o sorvetinho!


Espero que esse tutorial tenha ajudado e isso é tudo pessoal!

Tutorial feito por @ibiaalice