Pular para o conteúdo principal
A responsabilidade de um plugin não termina no lançamento. Esses padrões garantem que os plugins permaneçam previsíveis, bem documentados e suportados ao longo de todo o seu ciclo de vida.

Versionamento e release


A disciplina de versionamento e release é fundamental para garantir previsibilidade para os clientes e interoperabilidade em todo o ecossistema Lerian. Todos os plugins devem seguir as mesmas regras de versionamento e se alinhar com o ciclo oficial de releases da Lerian.

Versionamento

Todos os plugins devem usar Semantic Versioning 2.0.0.
  • MAJOR: mudanças incompatíveis de API ou comportamento.
  • MINOR: adições de funcionalidades compatíveis com versões anteriores.
  • PATCH: correções de bugs compatíveis com versões anteriores.
Confira nossa página simplificada de Versionamento para exemplos práticos.

Ciclo de release

Todos os releases de plugins devem se alinhar com o calendário oficial de releases da Lerian. Isso garante previsibilidade e atualizações tranquilas para clientes compartilhados.
  • Fluxos de desenvolvimento internos permanecem independentes
  • Releases públicos devem seguir o ciclo da Lerian
  • Versões patch para hotfixes ou atualizações críticas podem ser lançadas fora do ciclo
Releases desalinhados podem ser rejeitados para publicação no Marketplace da Lerian.

Documentação técnica


Documentação clara e consistente é obrigatória para todo plugin no ecossistema Lerian. Seus clientes dependem dela para adotar, integrar e operar sua solução efetivamente. Toda documentação oficial de plugins deve ser hospedada no Lerian Documentation Hub para garantir uma experiência unificada.

Documentação obrigatória

Todo plugin deve fornecer pelo menos:
  • Guias: para regras de negócio, configuração e uso.
  • Referência de API: para todos os endpoints expostos e documentação técnica.
Você pode hospedar sua própria documentação, mas os clientes devem ser redirecionados para o site oficial da Lerian para conteúdo técnico autoritativo.

Padrões e templates

Para garantir consistência e usabilidade, toda documentação deve seguir os Padrões de escrita da Lerian.
Esses templates são obrigatórios e garantem que os usuários finais recebam documentação de alta qualidade e acessível em todo o ecossistema.

Por que isso importa

Boa documentação é um requisito de conformidade, não um diferencial. Ela reduz o atrito de onboarding, previne uso indevido e mantém o suporte ao cliente eficiente.
Plugins sem documentação adequada não serão aprovados para publicação.

Processo de aprovação


Antes que um plugin possa ser publicado no Marketplace da Lerian, ele deve passar por um rigoroso processo de homologação. Isso garante que toda solução atenda aos padrões da Lerian de qualidade, segurança e compliance.
Plugins que falharem em qualquer uma dessas verificações não serão aprovados para publicação. Todos os problemas identificados devem ser resolvidos antes do reenvio.

Requisitos de homologação

Antes de ser publicado, todos os plugins devem passar por uma revisão formal, que inclui:
  • Checklist técnico — arquitetura, padrões de código, observabilidade e conformidade de API.
  • Checklist de segurança — pentests, auditorias e controles de proteção de dados.
  • Verificações de qualidade e performance — cobertura de testes, escalabilidade e relatórios de teste de stress.
  • Revisão de conformidade regulatória — verificação junto ao BACEN e outros órgãos reguladores.
  • Testes end-to-end — validação com Midaz ou outras soluções Lerian para confirmar interoperabilidade.

SLAs baseados em severidade


Se seu plugin é distribuído sob um acordo de suporte onde você, como parceiro de desenvolvimento, é responsável pela manutenção, você deve seguir as diretrizes de SLA baseadas em severidade da Lerian. Essas regras garantem a resolução oportuna de problemas e uma experiência consistente para clientes em todo o ecossistema.

Por que isso importa

Cumprir os SLAs reforça a confiança no ecossistema Lerian. Os clientes podem contar com tempos de resposta previsíveis, enquanto os parceiros demonstram responsabilidade e profissionalismo no suporte às suas soluções.

Prazos de resolução

Esses SLAs definem o tempo máximo permitido para entregar uma correção, com base na severidade do problema reportado:
SeveridadeTempo de resolução obrigatório
AltaCorreção em 5 dias úteis
MédiaCorreção em 10 dias úteis
BaixaCorreção em 30 dias úteis
Os prazos referem-se a dias úteis e são contados a partir do momento em que o problema é confirmado.Esses SLAs são obrigatórios para todos os plugins suportados por parceiros.
Isso garante uma experiência consistente para os usuários e reforça a confiança no ecossistema Lerian.