Para manter consistência nas informações e facilitar o rastreamento de alterações, precisamos estabelecer um padrão para commits, pull requests e *issues.*
Para os commits, utilizaremos o padrão de Conventional Commits, que segue a estrutura abaixo:
Basta informar o tipo de tarefa que foi feita e uma breve descrição em português. Logo abaixo, temos os tipos de tarefas mais comuns:
feat |
Commits que adicionam ou removem funcionalidades da API ou UI |
|---|---|
fix |
Commits que corrigem bugs de API ou de UI de uma feat anterior |
refactor |
Commits que reescrevem ou reestruturam seu código, mas que não mudam funcionalidades e/ou comportamentos |
perf |
Commits especiais que são do tipo refactor, mas que melhoram especificamente a performance da aplicação |
style |
Commits que alteram apenas formatações de código (como quebras de linha, ponto-e-vírgula ausentes, etc) |
test |
Commits que adicionam ou corrigem testes |
docs |
Commits que afetam apenas documentação (alterações de README, por exemplo) |
build |
Commits que afetam componentes de build, como dependências, infraestrutura, deploy, backup, recuperações |
chore |
Commits de outros tipos, como modificação de .gitignore, |
Para saber mais:
Para trabalhar em uma nova tarefa, verifique a lista de issues do repositório. Lá teremos todas as tarefas que precisam ser implementadas em nosso bot:
Issues · Orange-Juice-Tech/InfOranger-Bot-Oficial-da-Orange
<aside> 💡
Quando decidir em qual tarefa você vai trabalhar, coloque o seu nome como Assignee (responsável) ****da respectiva issue para evitar que outro desenvolvedor trabalhe na mesma tarefa.
</aside>
Crie uma nova *branch¹* sempre a partir da branch develop, que é onde teremos o desenvolvimento do nosso Bot.
<aside> 💡
Nunca crie uma branch a partir da main ou faça modificações diretas nela. Esta branch é exclusiva para nosso Bot em produção e só deverá ser modificada por administradores.
</aside>