opendatadiscovery/odd-team

O que odd-team faz?

Equipe de IA mantenedora para Open Data Discovery — coordena auditoria, fechamento de lacunas e manutenção sustentável nos repositórios ODD usando índices de navegação, scanners com rastreamento de cobertura e itens de trabalho estruturados.

Visão Geral

O odd-team atua como um mantenedor autônomo para o ecossistema Open Data Discovery, automatizando tarefas repetitivas de governança e manutenção. Ele usa um índice de navegação para entender a estrutura de cada repositório (caminhos, arquivos, dependências) e scanners de cobertura para identificar lacunas em áreas como:

• Testes unitários e de integração
• Documentação de API e guias do usuário
• Implementação de funcionalidades planejadas
• Configuração de CI/CD

Funcionalidades Principais

• Auditoria Automatizada: Varre repositórios em busca de conformidade com padrões definidos.
• Fechamento de Lacunas: Cria issues e pull requests para corrigir deficiências encontradas.
• Manutenção Sustentável: Prioriza tarefas com base no impacto e na disponibilidade de recursos.
• Rastreamento de Cobertura: Gera relatórios com métricas de cobertura para cada repositório.

Como Usar

1. Configuração Inicial:

   • Defina os repositórios ODD a serem monitorados no arquivo de configuração (odd-team.yml).
   • Configure as regras de auditoria (ex.: cobertura mínima de testes, presença de README.md).

2. Execução:

   odd-team audit --config odd-team.yml
   

3. Interpretação dos Resultados:

   • O comando gera um relatório coverage-report.json e uma lista de recomendações.
   • Itens de trabalho são criados automaticamente no rastreador de issues do GitHub.

Configuração

Exemplo de arquivo odd-team.yml:

repositories:
  - path: odd-platform
    rules:
      test_coverage: 80
      documentation: required
  - path: odd-connectors
    rules:
      test_coverage: 70
      dependencies: latest

actions:
  auto_create_issues: true
  auto_create_prs: false

Compatibilidade

• Plataformas: GitHub, GitLab (via módulo de integração)
• Linguagens: YAML, JavaScript, Python (para execução de scripts auxiliares)
• Ambiente: Node.js 18+, Python 3.9+

Contribuição

Veja CONTRIBUTING.md para diretrizes de contribuição. Issues e sugestões são bem-vindas!

Licença

Este projeto é licenciado sob a licença Apache 2.0. Consulte o arquivo LICENSE para mais detalhes.