|
| 1 | +# Contribuindo com o tabelião |
| 2 | + |
| 3 | +:+1::tada::+1::tada::+1::tada::+1::tada::+1::tada::+1::tada::+1::tada: |
| 4 | + |
| 5 | +# Iniciando o projeto |
| 6 | + |
| 7 | +## Instalando o node |
| 8 | + |
| 9 | +_TODO_ |
| 10 | + |
| 11 | +## Iniciando |
| 12 | + |
| 13 | +```bash |
| 14 | +git clone [email protected]:stonepayments/tabeliao-node.git |
| 15 | +cd tabeliao-node |
| 16 | +npm install |
| 17 | +``` |
| 18 | + |
| 19 | +## Rodando testes |
| 20 | + |
| 21 | +```bash |
| 22 | +npm test |
| 23 | +``` |
| 24 | + |
| 25 | +# Styleguides |
| 26 | + |
| 27 | +## Mensagens de commit |
| 28 | + |
| 29 | +- Mensagens em português |
| 30 | +- Escreva no presente e no modo imperativo ('Adiciona estrela que pisca') |
| 31 | +- Limite a primeira linha com 72 caracteres |
| 32 | +- Referencie issues ou pull requests |
| 33 | +- Adicione `[skip ci]` na mensagem de commit se for um commit de documentação |
| 34 | +- Considere usar os emojis: |
| 35 | + * :art: `:art:` quando melhorar a estrutura/formato do código |
| 36 | + * :racehorse: `:racehorse:` quando melhorar a performance |
| 37 | + * :non-potable_water: `:non-potable_water:` memory leaks |
| 38 | + * :memo: `:memo:` quando escrever alguma documentação |
| 39 | + * :bug: `:bug:` quando corrigir um bug |
| 40 | + * :fire: `:fire:` quando remover códigos ou arquivos |
| 41 | + * :green_heart: `:green_heart:` quando corrigir uma build no CI |
| 42 | + * :white_check_mark: `:white_check_mark:` quando adicionar testes |
| 43 | + * :lock: `:lock:` quando melhorar a segurança |
| 44 | + * :arrow_up: `:arrow_up:` quando der upgrade em dependências |
| 45 | + * :arrow_down: `:arrow_down:` quando der downgrade em dependências |
| 46 | + * :shirt: `:shirt:` quando remover problemas com linter |
| 47 | + * :poop: `:poop:` merda forte! |
| 48 | + * :construction: `:construction:` um commit de algo inacabado |
| 49 | + * :rocket: `:rocket:` commit que lança uma feature |
| 50 | + |
| 51 | + |
| 52 | +## Pull requests |
| 53 | + |
| 54 | +- Use as mensagens como a de commit |
| 55 | +- Tente explicar o máximo o possível e de maneira elegante (lembre-se que todos podem ler) |
| 56 | +- Considere que a pessoa que for ler o PR não faz a mínima ideia do que se trata |
| 57 | +- Inclua GIFs, imagens ou seja lá o que for que possa ajudar |
| 58 | + |
| 59 | +## Testes |
| 60 | + |
| 61 | +Como usamos o mocha, crie um `describe` para cada função para escrever os testes de unidade. |
0 commit comments