Skip to content

Commit

Permalink
Eh update readme (#3)
Browse files Browse the repository at this point in the history
* Atualiza readme com guia de contribuição

* Atualiza readme colocando o passo a passo para abrir PR
  • Loading branch information
erikhenrique authored Mar 11, 2018
1 parent 6be6998 commit 02a4ce3
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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?

Expand All @@ -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.


Expand All @@ -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:
Expand All @@ -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.
Binary file added imagens/abrir-pull-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imagens/sugestao-abrir-pr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 02a4ce3

Please sign in to comment.