diff --git a/README.md b/README.md index 652ad3b..b4d3330 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -# guia-ccbr -Guia de boas práticas para a Guilda Tech +# Guia Code Club Brasil + +Guia e boas práticas para a Guilda Tech + ## Quero contribuir, o que devo fazer? @@ -11,11 +13,11 @@ no [Slack](https://codeclubbrasilslack.herokuapp.com/) e também de uma olhada em nossas demandas através das issues dos projetos e nosso [Trello](https://trello.com/b/FefGk1A3/guilda-tech). Fique a vontade para atuar onde você mais se encaixa, mas gostariamos de -informar que o nosso Trello está com ordenado com a nossa prioridade. +informar que o nosso Trello está ordenado com a nossa prioridade. Somos uma comunidade onde **todos** nós somos voluntários, tenha paciência caso alguém demore para te responder, isso pode acontecer. Caso você se sinta -perdido, o nosso canal #guilda-tech no slack é o canal perfeito para pegar +perdido, o nosso canal #guilda-tech no slack é o canal perfeito para obter orientações com outros membros do Code Club. @@ -24,12 +26,12 @@ orientações com outros membros do Code Club. #### Pull Request Gostamos de trabalhar com Pull Requests e contamos com a sua ajuda para seguir com -isso. O nosso modelo é que cada feature desenvolvida seja colocada na branch principal -depois de ter feito um Pull Request. Se você não sabe abrir um Pull Request, não tem problema -dê uma lida aqui: [] +isso. O nosso modelo é que cada feature desenvolvida seja feita em uma branch separada +e aberta um Pull Request. +Caso você não saiba abrir um Pull Request (PR) dê uma lida nesta parte [aqui](#como-abrir-um-pull-request). -### Como fazer um Pull Request +### Como abrir um Pull Request Uma vez que você tenha algo para desenvolver, o primeiro passo é criar uma branch do git com o commando: @@ -44,7 +46,15 @@ o comando: isso fará que toda a sua branch e toda as modificações que foram feitas dentro dela suba para o nosso repositório no Github. +Feito isso o Github já vai sugerir para você criar um Pull Request conforme imagem: + +![imagem mostrando a sugestão do github para abrir PR](https://raw.githubusercontent.com/CodeClubBrasil/guia-ccbr/master/imagens/sugestao-abrir-pr.png) + +Clicando na botão 'Compare & pull request' você irá para a tela de abertura de Pull Request: +![imagem mostrando tela de abertura de pull request no github](https://raw.githubusercontent.com/CodeClubBrasil/guia-ccbr/master/imagens/abrir-pull-request.png) +Tente descrever o que você está fazendo, colocando referência da atividade no Trello (se existir), link da issue. +Com o Pull Request aberto, mande o link no canal #guilda-tech avisando que você abriu. diff --git a/imagens/abrir-pull-request.png b/imagens/abrir-pull-request.png new file mode 100644 index 0000000..cf2b7a3 Binary files /dev/null and b/imagens/abrir-pull-request.png differ diff --git a/imagens/sugestao-abrir-pr.png b/imagens/sugestao-abrir-pr.png new file mode 100644 index 0000000..e5b09b4 Binary files /dev/null and b/imagens/sugestao-abrir-pr.png differ