Guia de contribuição¶
Filosofia¶
Contribuições devem melhorar o produto sem adicionar complexidade desnecessária. O SotuHire valoriza clareza, simplicidade, testes e documentação.
Antes de contribuir¶
Leia:
Workflow¶
- Escolha uma tarefa pequena.
- Crie uma branch descritiva.
- Faça mudanças focadas.
- Adicione ou atualize testes.
- Atualize docs quando necessário.
- Abra PR com resumo claro.
Padrão de branch¶
feature/match-score
fix/pdf-empty-text
refactor/business-rules
docs/roadmap-update
test/seniority-rules
Padrão de PR¶
A descrição do PR deve responder:
- o que foi alterado?
- por que foi alterado?
- como testar?
- há impacto em regras de negócio?
- há impacto em privacidade?
Checklist¶
- Código roda localmente.
- Testes passam.
- Não há dados pessoais commitados.
- Não há chave de API.
- Regras novas estão documentadas.
- Mudança não adiciona overengineering.
Boas práticas¶
- prefira funções pequenas;
- evite duplicação;
- escreva nomes claros;
- documente decisão não óbvia;
- não misture refatoração gigante com feature pequena.