diff --git a/README.md b/README.md index 0988064..e9a6e15 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ -

Commit-Pull-Hackquest-2020

+# Commit Pull Hackquest 2020 + +

+Commit-Pull-Hackquest-2020 +

+ +

+Hacktoberfest-2020 Logo + +

- + Commit Pull Hackquest 2020 open pull requests @@ -8,17 +17,58 @@ GitHub issues GitHub forks -

- Hacktoberfest-2020 Logo - Commit-Pull-Hackquest-2020 -

-

-

+
+

+ +# Sobre o Evento: + +O Hacktoberfest é um evento organizado anualmente pela Digital Ocean. Ele tem como objetivo movimentar a comunidade open source visando trazer mais desenvolvedores de todos os níveis para contribuir e aprender mais sobre projetos de código aberto. O **Commit Pull Hackquest** é um evento criado pela **Commit Júnior** atrelado ao Hacktoberfest com o intuito de ensinar boas práticas de GitHub e auxiliar na conclusão dos desafios. + +## Como participar + +Contribuições fazem com que a comunidade open source seja um lugar incrível para aprender, inspirar e criar. Todas contribuições são extremamente apreciadas. + +## Desafios + +Os desafios do nosso repositórios abertos à pull requests são esses abaixo: + +### 1. Calculadora + +### 2. CRUD + +## Criando uma branch fazendo um Pull Request + +1. Realize um Fork do projeto + + ![Forking a project](https://media.giphy.com/media/1GYzZDBcFEUW7mOw46/giphy.gif) + +2. Vá até o repositório do fork no seu github e na parte code copie o link para clonar + +3. Abra o terminal, escolha um desafio de sua preferência e faça um clone git clone cole o link que você copiou. + +4. Escreva a sua solução do desafio na linguagem de programação especificada. + +5. Crie um branch com o desafio seguindo o modelo abaixo: + `git checkout -b challenges/id_challenge/nickname` +6. Depois faça: + `git add .` + +7. Realize o Commit: + `git commit -m 'Finalizando o desafio'` + +8. Realize o Push na Branch: + `git push origin challenges/id_challenge/nickname` + +9. Abra um Pull Request + +## Revisão de Pull Requests + +Como o nosso objetivo será dar a melhor experiência possível para o participante, nós iremos ter algumas regras básicas de revisão de código para que seja uma experiência interessante para quem está aplicando o desafio, sendo elas: + +- Reforçar uma leitura de código e tipagem quando possível; -## **Sobre o Evento:** -### o Hacktoberfest é um evento organizado anualmente pela Digital Ocean e tem como objetivo movimentar a comunidade open source para trazer mais desenvolvedores de todos os níveis para contribuir e aprender sobre ela. +- Erros de digitação/gramaticais e nomes de variáveis sem um contexto, tais como [a,b,c,x,y,z] deverão ser pedidas alterações; -## **Desafios:** +- Isolamento de funções quando necessário também poderá ser requisitado. -### 1 - Calculadora -### 2 - CRUD +#### Qualquer dúvida, estaremos no nosso [discord](https://discord.gg/DMvqHWR) para solucionar.