Skip to main content

Contribuindo

Setup

git clone https://git.rarolabs.com.br/devops/raro-reviewer.git
cd raro-reviewer
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Branches

  • main — código estável, pronto para deploy
  • feature/<nome> — novas funcionalidades
  • fix/<nome> — correções de bug

Fluxo de trabalho

  1. Crie uma branch a partir de main
  2. Implemente com testes
  3. Roda pytest -v e verifique que tudo passa
  4. Abra um MR para revisão

Convenções de commit

Conventional Commits:

feat: add NVIDIA NIM LLM client
fix: handle empty diff in parser
docs: update deployment guide
test: add tests for position mapper
refactor: extract prompt building to helper

Estrutura de pastas

Ao adicionar novo código, siga a arquitetura Ports & Adapters:

TipoLocalRegra
Lógica de negóciosrc/core/Sem imports de frameworks
Interfacessrc/ports/Apenas Protocol classes
Implementaçõessrc/adapters/Uma pasta por serviço
Rotas HTTPsrc/webhook/FastAPI routers
Testestests/unit/ ou tests/integration/Um arquivo por módulo

Code Review

Antes de subir seu MR, verifique:

  • Todos os testes passam (pytest -v)
  • Não há imports circulares
  • Core não importa frameworks
  • Testes cobrem os cenários principais
  • Commit messages seguem Conventional Commits