Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

91 lines (64 loc) · 2.58 KB
Raw

Contribuindo com o projeto

Preparando o ambiente

TODO

Reportando bugs

TODO

Sugerindo melhorias

TODO

Board de tarefas

Github issues

Fluxo de desenvolvimento

  • Pegar da tarefa mais velha para a mais nova
  • Abrir pull request
  • Code review
  • Done!

Fluxo do Git

Seguimos o GitFlow, mas usando Pull Requests para code review.

Styleguides

Mensagens de commit styleguide

  • Usar modo imperativo ("Adiciona feature" não "Adicionando feature" ou "Adicionada feature")
  • Primeira linha deve ter no máximo 72 caracteres
  • Considere descrever com detalhes no corpo do commit
  • Insira o código da issue do jira no início da mensagem ("CBKAP-67 Adiciona feature")
  • Considere usar um emoji no início da mensagem de commit
    • 🎨 :art: quando melhorar a estrutura/formato do código
    • 🐎 :racehorse: quando melhorar a performance
    • 🚱 :non-potable_water: memory leaks
    • 📝 :memo: quando escrever alguma documentação
    • 🐛 :bug: quando corrigir um bug
    • 🔥 :fire: quando remover códigos ou arquivos
    • 💚 :green_heart: quando corrigir uma build no CI
    • ✅ :white_check_mark: quando adicionar testes
    • 🔒 :lock: quando melhorar a segurança
    • ⬆️ :arrow_up: quando der upgrade em dependências
    • ⬇️ :arrow_down: quando der downgrade em dependências
    • 👕 :shirt: quando remover problemas com linter
    • 💩 :poop: merda forte!
    • mais? lista de emojis

Exemplo

git commit -m ":memo: Adiciona instruções de contribuição
>
> Foi criado o arquivo CONTRIBUTING.md com as instruções de
> como fazer um bom commit"

Pull Requests styleguide

  • Siga o padrão das mensagens de commit
  • Inclua GIFs animados sempre que possível
  • Verifique se todos os testes estão passando (CI)
  • Siga os styleguides de código
  • Documente a nova feature de acordo com o styleguide
  • Só pode fazer merge se tiver n approved
  • Considere editar o título colocando um emoji no início:
    • 👷 :construction_worker: quando ainda está com trabalho em progresso
    • 🔧 :wrench: quando precisar de mudanças
    • ⚠️ :warning: quando precisar de teste manual

Linguagem styleguide

TODO

Testes styleguide

TODO

Documentação styleguide

TODO