Pular para conteúdo

Como Contribuir

Obrigado por considerar contribuir com o projeto DestaquesGovbr!

Formas de Contribuir

Reportar Bugs

  1. Verifique se o bug já foi reportado nas issues

  2. Se não, abra uma nova issue com:

  3. Descrição clara do problema

  4. Passos para reproduzir
  5. Comportamento esperado vs atual
  6. Screenshots se aplicável

Sugerir Melhorias

  1. Abra uma issue com a tag enhancement
  2. Descreva a melhoria proposta
  3. Explique o benefício para o projeto

Contribuir com Código

  1. Faça fork do repositório
  2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)
  3. Faça commit das alterações (git commit -m 'feat: adiciona nova feature')
  4. Push para a branch (git push origin feature/nova-feature)
  5. Abra um Pull Request

Padrões de Código

Python (Scraper)

  • Formatação: Black
  • Linting: Ruff
  • Testes: pytest

TypeScript (Portal)

  • Formatação: Biome
  • Linting: Biome
  • Framework: Next.js 15

Convenção de Commits

Usamos Conventional Commits:

feat: nova funcionalidade
fix: correção de bug
docs: documentação
style: formatação
refactor: refatoração
test: testes
chore: manutenção

Code Review

  • Todos os PRs precisam de pelo menos 1 aprovação
  • Responda ao feedback de forma construtiva
  • Mantenha PRs pequenos e focados

Dúvidas?