🤝 Contribuindo com o Projeto¶
Obrigado por considerar contribuir com este projeto! Para mantermos a qualidade e organização, siga as instruções abaixo.
🚀 Como começar¶
-
Fork do repositório.
-
Crie uma branch com um nome descritivo:
git checkout -b feat/nome-da-feature
-
Faça suas alterações no código.
-
Garanta que o projeto roda sem erros.
- Envie suas alterações via Pull Request (PR).
📝 Mensagens de Commit¶
Os commits devem seguir o padrão:¶
<tipo>: <descrição curta>
Tipos aceitos:¶
feat → nova funcionalidade
fix → correção de bug
docs → documentação
style → formatação (sem alterar lógica)
refactor → refatoração de código
test → criação/alteração de testes
chore → manutenção do projeto
Exemplos:
feat: adicionar tela de cadastro de usuário
fix: corrigir erro cálculo de média
docs: atualizar README com instruções de instalação
🚨 Caso o commit for resolver uma issue aberta adicione (#numero-da-issue) no final da mensagem do commit
📂 Estrutura do Código¶
-
Mantenha a organização de pastas já definida no projeto.
-
Nomeie arquivos e pastas em minúsculo-com-hífen (exemplo-arquivo.js).
-
Evite nomes genéricos como temp, test1, new.
✅ Padrão de Código¶
-
Utilize a formatação definida 4 espaços (quando aplicável).
-
Siga boas práticas de legibilidade: código limpo, funções curtas, nomes claros.
-
Escreva comentários apenas quando necessário para contexto.
🧪 Testes¶
-
Sempre que possível, adicione testes para as novas funcionalidades.
-
Garanta que todos os testes existentes passam antes de abrir o PR:
🔎 Pull Requests (PRs)¶
-
Preencha a descrição do PR explicando: o que foi feito, por que e como testar.
-
Relacione issues se existir (ex: Closes #10).
-
Mantenha o PR focado em uma mudança específica.
💡 Boas Práticas¶
-
Commits pequenos e objetivos.
-
Discussões e dúvidas devem ser abertas como issues.
-
Sempre atualize sua branch com a main antes de abrir PR.
📜 Código de Conduta¶
Todos os participantes devem seguir o Código de Conduta da Comunidade. Respeito e colaboração são essenciais para o sucesso do projeto.