Guia de Contribuicao¶

Diretrizes para contribuir com o projeto TepConfina.

Git Flow¶

O projeto segue o modelo de branching baseado em trunk:

gitGraph
    commit id: "main"
    branch feature/nova-funcionalidade
    commit id: "feat: implementacao"
    commit id: "feat: testes"
    checkout main
    merge feature/nova-funcionalidade id: "PR #42"
    branch fix/correcao-bug
    commit id: "fix: correcao"
    checkout main
    merge fix/correcao-bug id: "PR #43"

Fluxo de Trabalho¶

1. Crie uma branch a partir de main
2. Implemente as alteracoes
3. Abra um Pull Request
4. Aguarde a revisao de codigo
5. Apos aprovacao, faca o merge

Nomenclatura de Branches¶

Convencao de Commits¶

Utilizamos Conventional Commits:

<tipo>(<escopo>): <descricao>

Tipos Permitidos¶

Exemplos¶

feat(lotes): adicionar filtro por status
fix(auth): corrigir refresh token expirado
docs(api): documentar endpoint de pesagens
refactor(services): extrair validacoes para classe separada
test(animais): adicionar testes para cadastro

Template de Pull Request¶

## Descricao
Breve descricao das alteracoes realizadas.

## Tipo de Alteracao
- [ ] Nova funcionalidade (feat)
- [ ] Correcao de bug (fix)
- [ ] Refatoracao (refactor)
- [ ] Documentacao (docs)

## Checklist
- [ ] Codigo segue os padroes do projeto
- [ ] Testes adicionados/atualizados
- [ ] Documentacao atualizada (se aplicavel)
- [ ] Build passa sem erros
- [ ] Sem warnings do linter

## Screenshots (se aplicavel)

Checklist de Code Review¶

O que verificar¶

• Funcionalidade: O codigo faz o que se propoe?
• Testes: Existem testes adequados? Cobrem os cenarios importantes?
• Seguranca: Dados sensiveis estao protegidos? Inputs sao validados?
• Performance: Consultas ao banco sao eficientes? Existe paginacao?
• Legibilidade: O codigo e claro e bem organizado?
• Convencoes: Segue os padroes do projeto (naming, arquitetura)?

Padroes de Codigo¶

Backend (.NET)¶

• Seguir Clean Architecture (Domain, Application, Infrastructure, API)
• Soft delete via IsDeleted (nunca deletar fisicamente)
• DTOs para comunicacao entre camadas
• Injecao de dependencia para todos os servicos

Frontend (React)¶

• Componentes funcionais com TypeScript
• Zustand para estado de autenticacao
• TanStack Query para estado do servidor
• react-hook-form + zod para formularios
• Tailwind CSS para estilizacao

Mobile (Flutter)¶

• Riverpod para gerenciamento de estado
• Hive para armazenamento local
• Freezed para modelos imutaveis