Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

📜 Escrevendo RFCs

Mudanças significativas na arquitetura, protocolos ou economia do PAEBIRU exigem uma RFC (Request for Comments). Este processo garante que as decisões sejam debatidas, documentadas e imutáveis após a ratificação.


1. Quando escrever uma RFC?

  • Adição de um novo Bounded Context (crate).
  • Mudança em uma interface pública de Port (trait em crates/*/ports/).
  • Alteração em protocolos de rede ou formatos de recibo.
  • Novas regras de governança ou incentivos econômicos.

2. O Processo (Fluxo Vital)

  1. Idea: Discuta a ideia em uma Issue ou Discussion com a tag rfc-proposal.
  2. Draft: Solicite um número (ex: RFC 054) e copie o template oficial.
  3. Proposed: Abra um PR com o status PROPOSED. O PR deve ficar aberto por pelo menos 14 dias para debate técnico.
  4. Standard: Se houver consenso, um mantenedor marca como STANDARD e faz o merge.

3. Template de RFC

Copie de .agents/skills/paebiru-rfc-writer/references/TEMPLATE.md. Seções obrigatórias:

  • Resumo: Um parágrafo para leigos.
  • Motivação: Por que agora? Qual o custo de não fazer?
  • Especificação Técnica: Detalhes granulares (structs, enums, sequências).
  • Impacto em BCs: Tabela de quais crates serão alterados.

4. Regras de Ouro

  • Numeração Imutável: Uma vez atribuído, o número da RFC nunca muda.
  • Supersedes: Se uma RFC nova substitui uma antiga, use o campo supersedes no cabeçalho.
  • Foco no Domínio: Evite detalhes de implementação (ex: “usar biblioteca X”) a menos que seja estritamente necessário para o protocolo.

5. Veja também