AGENTS¶

Missão¶

Este repositório representa a documentação oficial da CoreFlow Platform.

Toda implementação deverá seguir rigorosamente os padrões definidos nesta base de conhecimento.

Este documento é o ponto de entrada obrigatório para qualquer agente de IA que participe do desenvolvimento da plataforma.

Objetivo¶

Garantir que toda alteração realizada na CoreFlow Platform seja:

consistente;
arquiteturalmente correta;
documentada;
testável;
escalável;
reutilizável.

Produtos¶

A CoreFlow Platform é composta pelos seguintes produtos:

CoreFlow CRM
CoreFlow ERP
CoreFlow Finance
CoreFlow RH
CoreFlow WMS
CoreFlow BI
CoreFlow AI
CoreFlow Service
CoreFlow RPA

Todos compartilham uma arquitetura única.

Arquitetura¶

A plataforma está organizada em quatro níveis.

CoreFlow Platform

├── Shared

├── Core

├── Products

└── Infrastructure

Nenhum produto deverá implementar funcionalidades já existentes em Shared ou Core.

Stack Oficial¶

Backend

Python 3.12+
Django 5+
Django REST Framework
Celery
Redis
PostgreSQL

Frontend

React
Next.js
TypeScript

Infraestrutura

Docker
Nginx
GitHub Actions

Fonte Oficial¶

Toda decisão deverá seguir a seguinte ordem de prioridade:

AGENTS.md
standards/
architecture/
templates/
examples/
docs/

Nunca inverter essa ordem.

Organização¶

A documentação está organizada em:

standards/
architecture/
templates/
examples/
docs/

Cada diretório possui uma responsabilidade específica.

Regras Gerais¶

É obrigatório:

respeitar a arquitetura da plataforma;
reutilizar componentes existentes;
evitar duplicação;
documentar toda nova funcionalidade;
manter compatibilidade entre produtos.

É proibido:

criar soluções paralelas;
duplicar regras de negócio;
alterar arquitetura sem ADR;
implementar código sem documentação correspondente.

Fluxo Oficial¶

Toda implementação seguirá obrigatoriamente:

Documentação

↓

Arquitetura

↓

Modelagem

↓

Implementação

↓

Testes

↓

Revisão

↓

Entrega

Nunca implementar antes da documentação.

Documentação¶

Cada documento deve tratar apenas um único assunto.

Nunca criar documentos extensos contendo diversos assuntos distintos.

Templates¶

Todo documento deverá utilizar um template oficial localizado em:

templates/

Standards¶

Todo código deverá obedecer aos padrões definidos em:

standards/

Architecture¶

Toda decisão arquitetural deverá consultar:

architecture/

Examples¶

Sempre utilizar exemplos oficiais antes de implementar novos componentes.

examples/

Produtos¶

Cada produto possui documentação independente em:

docs/products/

Commit¶

Utilizar Conventional Commits.

Exemplos:

docs(crm): documenta módulo Leads

feat(core): implementa autenticação

fix(api): corrige endpoint Accounts

Objetivo Final¶

Esta documentação deverá permitir que Claude Code e OpenCode implementem qualquer funcionalidade da CoreFlow Platform consultando apenas esta base documental, preservando consistência arquitetural, qualidade técnica e padronização entre todos os produtos.