CONTRIBUTING.md

💟 Contribuindo com o nosso projeto

Para ter sucesso na sua contribuição siga o nosso passo a passo que vai desde a configuração inicial... a solicitação do último pull request 🏆

Configurando   |    Contribuindo      

1º Pull-request ✅       2º Pull-request ✅✅         3º Pull-request ✅✅✅         4º Pull-request ✅✅✅✅        

🛠️ Configurando sua área de trabalho

Garanta que a lista abaixo já esteja devidamente instalada na sua máquina

Se você já tem o VSCode instalado, uma ótima maneira de descobrir é digitando no terminal os comandos para verificar a versão de cada uma:

node -v

git --version

yarn -v

Se você não tiver algum, segue o link com o site oficial:

1. 🔽 VSCode
2. 🔽 Node
3. 🔽 Git
4. 🔽 Yarn

💟 Contribuindo

Vamos começar!👩🏿‍💻👩🏻‍💻👩🏽‍💻👩🏾‍💻👩🏼‍💻

✨ Você precisa fazer um fork do repositório do Women Who Code. Segue o link:

Women Who Code

⚠️ Isto irá criar uma cópia para o seu repositório

,

✨ Você precisa fazer um clone do seu repositório que foi forkado.

✨ Abra o terminal. Primeiro vamos criar uma pasta para o WW Code.

⚠️ Digite o comando abaixo e aperte Enter:

mkdir wwcode

✨ Agora vamos entrar nesta pasta.

⚠️ Digite o comando abaixo e aperte Enter:

cd wwcode

✨ No terminal, digite:

git clone

⚠️ Clique com o botão direito do mouse e cole o link copiado. Deverá ficar assim:

git clone https://github.com/SEU-USUÁRIO-DO-GITHUB/wwcode-hacktoberfest-2020.git

✨ Agora vamos entrar na pasta clonada. Digite o comando abaixo e aperte Enter

cd wwcode-hacktoberfest-2020

✨ Para instalar as dependências necessárias no repositório local, digite um dos comandos abaixo:

yarn ou npm install

💟 Agora vamos contribuir!

✨Digite no terminal

code .

✨Você deve localizar no Visual Studio Code a seguinte pasta:

src

E seguir o caminho até o arquivo src > data > team.js

✨Observe que o arquivo tem vários dados. Você irá procurar por " title: " e localizar em qual categoria se encaixa.

Por exemplo: Se você for da categoria "Members", você vai editar este trecho posteriormente:

✨Primeiramente você vai copiar o objeto que estiver entre { }, colar logo abaixo dele e apagar todas as informações para deixá-lo assim, como no segundo objeto:

Lembre-se: você vai criar um novo, não altere o que já estiver.

⚡

✨No campo de "photo" você irá inserir o link da sua foto de perfil do github.

Aperte " Ctrl + s " para salvar o aquivo

✨Vamos voltar ao terminal e seguir os passos que aprendemos mais cedo para mandar uma modificação ao repositório remoto.

git status

git add .

git commit -m "mensagem do commit com descrição"

git push origin master

✨Você acabou de fazer o "commit", e após o "push" tudo foi enviado para o seu repositório remoto.

Agora vamos voltar para a página do github

Você deve encontra-la assim:

✨ Clique na Pull Request como está marcada na imagem acima e você será encaminhada para esta página abaixo:

🔍 Vamos observar algumas coisas nesta página

✨ Note que a comparação dos repositórios é feita da direira para esquerda.

✨ A branch master do seu repositório está sendo comparada com a branch master do reprositório do wwcode.

✨ Quando aparece o "Able to merge", significa que não há conflitos entre os repositórios.

⚠️ Caso apareça uma mensagem de conflito (ela estará em vermelho), volte para o vscode e observe se mudou algo do código que clonou. Até uma vírgula apagada pode dar conflito.

✨ É considerado uma boa prática escrever um título e uma descrição mas não é obrigatório.

✨ Clique em "Create pull request" e PRONTO! Sua primeira pull request foi criada

⚠️ Note que ocorreu um erro de check primeiro mas o mais importante é a mensagem de sucesso "This branch has no conflicts with the base branch"

✨ E com a exibição da mensagem: "This branch has no conflicts with the base branch" sua pull request foi concluída com sucesso! ✅

⭐

✨Ao voltar para o vs code, no campo de "name" você irá inserir seu nome e um sobrenome.

Aperte " Ctrl + s " para salvar o aquivo

✨Vamos voltar ao terminal e seguir os passos da primeira pull request. Fazer o commit e solicitar a pull request no github.

🌟

✨Ao voltar para o vs code, no campo de "description" você irá inserir algo sobre você. Exemplo: Adoro contribur com a comunidade, amo viajar e sou super fã de Harry Potter!🥰

Aperte " Ctrl + s " para salvar o aquivo

✨Vamos voltar ao terminal e seguir os passos da primeira pull request. Fazer o commit e solicitar a pull request no github.

✨

✨Ao voltar para o VSCode, no arquivo "team.js" nos campos de "github" e "linkedin" você irá inserir os links do seu perfil nas respectivas páginas

Aperte " Ctrl + s " para salvar o aquivo

✨Vamos voltar ao terminal e seguir os passos da primeira pull request. Fazer o commit e solicitar a pull request no github.

🏆 Feito!!

💟 Você completou as 4 Pull Requests e agora pode ir na página do Hacktoberfest para conferir!