Convenções¶
Aqui serão definidas as diretrizes que regem as boas práticas de desenvolvimento do projeto, ao longo do tempo mais tópicos serão adicionados ou editados, o que está aqui deve ser seguido por todos que trabalharem no código para manter um padrão de qualidade.
Conventional Commits¶
Este é um conjunto simples de regras para a criação de um histórico de commits explícito, descrevendo os recursos, correções e alterações significativas feitas em mensagens de commit. Os commits do projeto devem ser feitos em Português Brasileiro, não precisando conter acentuação.
Exemplos:¶
feat(quadro): adicionar suporte a desenhofix(ia): corrigir resposta vaziadocs(wiki): atualizar guia de usorefactor(socket): melhorar performance
Tipos mais usados:¶
feat: nova funcionalidadefix: correção de bugdocs: mudanças na documentaçãostyle: formatação, sem mudança de lógicarefactor: refatoração sem alteração de funcionalidadetest: testes automatizadoschore: tarefas que não afetam o código de produção