|
1 | | -# Guia Para Contribuidores do Projeto |
| 1 | +# Guia para Contribuidores |
2 | 2 |
|
3 | | -## Index |
4 | | - |
5 | | -- [Como contribuir?](#como-contribuir) |
6 | | - - [1º Passo](#1º-passo) - Fork |
7 | | - - [2º Passo](#2º-passo) - Clonagem |
8 | | - - [3º Passo](#3º-passo) - Add link para repositório oficial |
9 | | - - [4º Passo](#4º-passo) - Crie uma branch para contribuir |
10 | | - - [5º Passo](#5º-passo) - Adicione e commite a contribuição |
11 | | - - [6º Passo](#6º-passo) - Envie a branch com a contribuição para o fork |
12 | | - - [7º Passo](#7º-passo) - Faça o pull requets da branch para o projeto oficial |
13 | | -- [Contribuição aprovada, o quê fazer?](#contribuição-aprovada-o-quê-fazer) |
14 | | - - [Deletando branch antiga localmente](#deletando-branch-antiga-localmente) |
15 | | -- [Sincronizando o fork/clone com o repositório oficial](#sincronizando-o-forkclone-com-o-repositório-oficial) |
16 | | - - [Sincronize o clone](#sincronize-o-clone) |
17 | | - - [Sincronize o fork](#sincronize-o-fork) |
18 | | -- [Links úteis](#links-úteis) |
19 | | - |
20 | | - |
21 | | -## Como contribuir? |
22 | | - |
23 | | -Para fazer contribuições certifique-se de que tenha o [git](https://git-scm.com/) instalado em seu ambiente. |
24 | | - |
25 | | -Com o **git** já instalado, siga os passoa abaixo. |
26 | | - |
27 | | -### 1º Passo |
28 | | - |
29 | | -Faça o **fork** desse repositório para sua conta clicando no botão: |
30 | | - |
31 | | - |
32 | | - |
33 | | -Você será redirecionado para sua conta assim que o processo for concluído. |
34 | | - |
35 | | -### 2º Passo |
36 | | - |
37 | | -Após ter o repositório em sua conta, faça o **clone** em seu ambiente local: |
38 | | - |
39 | | -```bash |
40 | | -$ git clone https://github.com/<NOME_DA_SUA_CONTA>/alice.git |
41 | | -``` |
42 | | - |
43 | | -### 3º Passo |
44 | | - |
45 | | -Com o clone em seu ambiente, linke o repositório local ao remoto da organização [Coding in Community](https://github.com/Coding-in-community/alice): |
46 | | - |
47 | | -```bash |
48 | | -$ git remote add upstream https://github.com/Coding-in-community/alice.git |
49 | | -``` |
50 | | - |
51 | | -Isso servirá para sincronizar atualizações feitas no repositório oficial para seu ambiente local. |
52 | | - |
53 | | -> OBS: Esse comando só é necessário executar uma unica vez após a clonagem. |
54 | | -
|
55 | | -Para verificar se ocorreu tudo certo, execute em no terminal: |
56 | | - |
57 | | -```bash |
58 | | -$ git remote --v |
59 | | -``` |
60 | | - |
61 | | -Se tudo ocorreu bem, deverá ter uma saída semelhante a essa: |
62 | | - |
63 | | -```bash |
64 | | -origin https://github.com/<NOME_DA_SUA_CONTA>/alice.git (fetch) |
65 | | -origin https://github.com/<NOME_DA_SUA_CONTA>/alice.git (push) |
66 | | -upstream https://github.com/Coding-in-community/alice.git (fetch) |
67 | | -upstream https://github.com/Coding-in-community/alice.git (push) |
68 | | -``` |
69 | | - |
70 | | -### 4º Passo |
71 | | - |
72 | | -Crie uma **branch** para fazer sua contribuição: |
73 | | - |
74 | | -```bash |
75 | | -$ git checkout -b feature/nome_da_feature |
76 | | -``` |
77 | | - |
78 | | -Agora adicione suas contribuições para o projeto. |
79 | | - |
80 | | -### 5º Passo |
81 | | - |
82 | | -Adicione suas contribuições: |
83 | | - |
84 | | - |
85 | | -```bash |
86 | | -$ git add arquivo_exemplo.js |
87 | | -``` |
88 | | - |
89 | | -> OBS: Adicione todos os arquivos/diretórios adicionados e/ou modificados |
| 3 | +> Nota: Se essa é a sua primeira vez contribuindo em um projeto, leia [este guia](https://github.com/Coding-in-community/.github/blob/master/FIRST_CONTRIBUTION.pt.md) antes de prosseguir. |
90 | 4 |
|
| 5 | +## Index |
91 | 6 |
|
92 | | -Agora faça o **commit**: |
93 | | - |
94 | | -```bash |
95 | | -$ git commit -m "Descrição da contribuição" |
96 | | -``` |
97 | | - |
98 | | -### 6º Passo |
99 | | - |
100 | | -Concluindo sua contribuição envie-a para o repositório remoto em sua conta: |
101 | | - |
102 | | -```bash |
103 | | -$ git push origin feature/nome_da_feature |
104 | | -``` |
105 | | - |
106 | | -### 7º Passo |
107 | | - |
108 | | -Em sua conta no github envie um **Pull Request** com sua contribuição para o repositório oficial: |
109 | | - |
110 | | - |
111 | | - |
112 | | -Agora aguarde a revisão de um dos mantenedores do projeto. |
113 | | - |
114 | | -## Contribuição aprovada, o quê fazer? |
115 | | - |
116 | | -Depois de um pull request aprovado, caso não queira contribuir novamente, poderá apagar a branch que usou para fazer a contribuição na própria página do Pull Request ou excluir o fork de sua conta. |
117 | | - |
118 | | -Caso queira fazer outras contribuições que não tenha relação com a branch da contribuição antiga, delete a antiga e crie uma nova. |
119 | | - |
120 | | -### Deletando branch antiga localmente |
121 | | - |
122 | | -Vá para a branch padrão: |
123 | | - |
124 | | -```bash |
125 | | -$ git checkout master |
126 | | -``` |
127 | | - |
128 | | -Delete a antiga: |
129 | | - |
130 | | -```bash |
131 | | -$ git branch -d nome_da_branch_antiga |
132 | | -``` |
133 | | - |
134 | | -Agora crie uma nova branch e repita os passos [4º Passo](#4º-passo), [5º Passo](#5º-passo), [6º Passo](#6º-passo) e [7º Passo](#7º-passo) |
135 | | - |
136 | | - |
137 | | -## Sincronizando o fork/clone com o repositório oficial |
138 | | - |
139 | | -Para sincronizar o fork/clone com as novas features que tem no repositório oficial siga os passos abaixo: |
140 | | - |
141 | | -### Sincronize o clone |
142 | | - |
143 | | -Certifique-se de estar na branch padrão, que para esse projeto é a `master`: |
144 | | - |
145 | | -```bash |
146 | | -$ git checkout master |
147 | | -``` |
148 | | - |
149 | | -Agora sincronize com: |
150 | | - |
151 | | -```bash |
152 | | -$ git pull upstream master |
153 | | -``` |
154 | | - |
155 | | -Após isso o ambiente local estará sincronizado. |
156 | | - |
157 | | -### Sincronize o fork |
158 | | - |
159 | | -Com o ambiente local sincronizado, sincronize o remoto também: |
160 | | - |
161 | | -```bash |
162 | | -$ git push origin master |
163 | | -``` |
164 | | - |
165 | | -Pronto, ambiente local e remoto sincronizado com o oficial. |
| 7 | +- [Commit Convention](#commit-convention) |
| 8 | +- [Linter e Code formatter](#linter-e-code-formatter) |
166 | 9 |
|
| 10 | +## Commit Convention |
167 | 11 |
|
168 | | -## Links úteis |
| 12 | +Atualmente, estamos seguindo [esta](https://devbrotherhood.github.io/cmc/) convenção para commits e todos devem segui-la dentro do projeto. |
169 | 13 |
|
170 | | -Caso tenha dúvida com algum comando usado ou queira entender melhor, veja um dos links abaixo: |
| 14 | +## Linter e Code formatter |
171 | 15 |
|
172 | | -- [Documentação do git](https://git-scm.com/docs) |
173 | | -- [Curso de Git - Rodrigo Branas](https://www.youtube.com/playlist?list=PLQCmSnNFVYnRdgxOC_ufH58NxlmM6VYd1) |
| 16 | +O linter usado no projeto é o [ESLint](https://eslint.org/), já o code formatter é o [Prettier](https://prettier.io/). Certifique-se de ter instalado as extensões apropriadas em seu editor. |
0 commit comments