Conformity gate
Conformity gate do Apothem — a fração mecânica do portão de pré-emissão de quinze barras (M1-M15) pelo qual todo artefato emitido precisa passar.
As quinze barras
| Barra | ID | Mandato | Classe de verificação | Falha → ação |
|---|---|---|---|---|
| 1 | M1 | Agnosticismo quanto ao projeto anfitrião | Raciocinada | Revisar para seguir as convenções do anfitrião |
| 2 | M2 | Disciplina editorial (livro-razão de divulgação) | Raciocinada | Adicionar marcadores de divulgação |
| 3 | M3 | Dez dimensões de qualidade | Mecânica + raciocinada | Revisar nas dimensões que falham |
| 4 | M4 | Autoaplicação (bloco de verificação presente) | Raciocinada | Registrar o bloco de verificação |
| 5 | M5 | Princípio de autoridade (nenhuma identidade / endpoint / segredo fabricado) | Mecânica | Encaminhar para consulta |
| 6 | M6 | Incorporação de expertise (lacunas expostas) | Raciocinada | Expor lacunas; citar refinamentos |
| 7 | M7 | Anotação de opções (marcador Recommended + justificativa do fator determinante) | Mecânica | Anotar os conjuntos de opções |
| 8 | M8 | Definitividade (nenhuma hesitação na prosa prescritiva) | Mecânica | Converter hesitações em condicionais |
| 9 | M9 | Alavancagem visual (temas estruturais trazem diagramas) | Mecânica + raciocinada | Criar / atualizar o diagrama |
| 10 | M10 | Vinculação bidirecional (ponteiros de retorno recíprocos fechados) | Mecânica | Fechar as meias-arestas |
| 11 | M11 | Sprints ágeis (Objetivo / Backlog / DoR / DoD / Revisão / Retrospectiva) | Raciocinada | Reestruturar como sprints |
| 12 | M12 | Relatórios de fase e disposição canônica | Mecânica + raciocinada | Redigir o resumo; realocar para a disposição canônica |
| 13 | M13 | Ofício de código (lint / formatação / verificação de tipos; número mágico; bare-except) | Mecânica | Aplicar as regras de ofício de código de cada linguagem |
| 14 | M14 | Sistemicidade (declara montante / jusante / pares / aplicadores) | Mecânica + raciocinada | Declarar; indexar nos registros |
| 15 | M15 | Pronto para produção (testes + documentação + CHANGELOG + commit conforme + CI em verde + estabilidade semver) | Mecânica + raciocinada | Adicionar as superfícies ausentes |
O portão executa apenas validadores verificáveis por máquina. O julgamento raciocinado que as barras Raciocinadas exigem, e a metade raciocinada de cada barra Mecânica + raciocinada, é avaliado na revisão.
Escala de severidade
O portão não tem a escala Crítica, Importante ou Consultiva e não tem limite de dois achados. Sem --strict (ou APOTHEM_CONFORMITY_STRICT=1), o portão relata os achados e sai com 0. Com --strict, uma verificação de arquivo único ou de hook sai com 2 quando qualquer matcher falha, e uma execução sobre o corpus (--all ou --all-perwrite) sai com 2 quando um validador ou matcher bloqueante falha; os achados consultivos são apenas relatados. O hook de Write/Edit instalado não passa --strict, então ele relata os achados e a gravação prossegue, a menos que APOTHEM_CONFORMITY_STRICT=1 esteja definido no ambiente do hook.
Validadores
A fração mecânica fica em src/apothem/conformity/, orquestrada por src/apothem/conformity/gate.py.
Cada validador é executado de uma de três maneiras:
- per-write: em cada gravação pendente (
--hook), ou em cada arquivo rastreado com--all-perwrite. - standalone: no repositório inteiro com
--all, ou um de cada vez com--check <name>. - change-set: contra um diff preparado (staged), executado diretamente como
python -m apothem.conformity.semver_stability_grep --staged, e não por meio do portão.
A tabela abaixo é gerada a partir dos módulos dos validadores.
The conformity package ships 54 validators: 22 per-write, 31 standalone and 1 change-set. The gate registers the per-write and standalone ones.
| Validator | Runs | Rule anchor | What it checks |
|---|---|---|---|
agent-capability-grep | standalone | agent-capability-discipline (per-harness capability matrix) | Verify every harness declares its agentic-capability matrix. |
agents-md-coverage-grep | standalone | rules/agents-md-convention.md | Flag stale agent-companion files under the root-only AGENTS.md convention. |
agnosticism-grep | standalone | rules/agnostic-posture.md §3 (harness neutrality) + §1 (default-off) | Flag harness bias and re-introduced enforcement presets in shipped surfaces. |
always-on-budget-grep | per-write | D1 token-budget-discipline §Always-on body budget | Body-budget conformity matcher for always-on rules. Pointed at a rules directory it also holds the loaded always-on set and the rule index to byte ceilings. |
bare-except-grep | per-write | M13.3 error handling | Flag bare except clauses without typed exceptions or re-raise. |
binding-five-direction-grep | standalone | M10 bidirectional-binding §1 (five-direction Bindings section) | Require the five-direction Bindings section on every rule, command, agent, and skill. |
binding-reciprocity-corpus-grep | standalone | M10 bidirectional-binding §2 (↔ self-reciprocal) | Cross-file binding-reciprocity corpus walk — the ↔-symmetric half-edge check. |
binding-reciprocity-grep | per-write | M10 bidirectional-binding §Notation | Flag binding declarations using non-canonical arrow notation. |
brand-mark-grep | per-write | rules/plain-language.md (brand-mark display/identifier casing) | Flag brand-mark display/identifier form drift on brand-touched surfaces. |
commented-out-code-grep | per-write | M13.1 why-not-what comments | Flag substantial commented-out code blocks left in source. |
completion-claim-grep | per-write | rules/session-closure.md (verifiable-close output honesty) | Flag unsupported completion / guarantee claims in cohort prose. |
conventional-commit-grep | standalone | CLAUDE.md Coding Conventions — Conventional Commits | Flag HEAD commit messages that drift from the Conventional-Commits grammar. |
copilot-instructions-presence-grep | per-write | — | GitHub Copilot surface presence check. |
cross-platform-matrix-grep | standalone | cross-platform OS x Python CI matrix | Verify CI declares a cross-platform OS x Python matrix. |
determinism-grep | standalone | rules/determinism.md | Prove every command and skill surface has a deterministic output shape. |
diagram-staleness-grep | per-write | M9 visual-leverage §Fidelity | Flag diagrams whose verification date is missing or stale. |
dynamism-grep | standalone | rules/dynamism.md (static-version embeds) | Flag static-string version embeds in dynamism-required surfaces. |
editorconfig-presence-grep | standalone | supply-chain SOTA-rigor §editorconfig | Verify a canonical .editorconfig is present at the project root. |
file-header-grep | per-write | — | Authorship-header presence and canonical-form check. |
freshness-token-grep | standalone | rules/freshness-facade.md | Flag freshness-narrative phrases on shipped public surfaces. |
frontmatter-grep | per-write | the per-class frontmatter JSON Schemas (src/apothem/schemas/) | Validate per-artifact-class YAML frontmatter against required-key sets. |
frontmatter-value-grep | standalone | per-class JSON Schema enum/pattern value constraints | Validate frontmatter VALUES against the per-class JSON Schema enum/pattern constraints. |
gate-evidence-grep | standalone | commands/plan-execute.md Gate evidence; rules/pre-emission-gate-bars.md section 2 (attestation schema) | Advisory: flag plan-suite gate claims that lack a command, an exit status or output, and a HEAD SHA beside them, and fifteen-bar attestations that omit a field of the rule's schema. |
gitattributes-presence-grep | standalone | supply-chain .gitattributes contract | Verify the repo-root .gitattributes carries the canonical contract. |
harden-runner-grep | standalone | harden-runner egress baseline | Verify every workflow job opens with a conformant harden-runner step. |
hedging-grep | per-write | M8 definitiveness §Hedging | Flag hedging vocabulary in prescriptive contexts. |
license-author-consistency-grep | per-write | — | LICENSE author-identity presence check. |
link-check | per-write | rules/code-craft-markdown.md §6 Link Discipline | Validate Markdown internal links against the on-disk reference graph. |
magic-number-grep | per-write | M13.10 magic numbers | Flag magic numbers in source code. |
multi-surface-coherence-grep | per-write | — | Shared-claim coherence across AI-conventions surfaces. |
naming-grep | standalone | CLAUDE.md Coding Conventions (kebab-case naming) | Validate filesystem paths against the canonical naming convention. |
no-global-plans-grep | standalone | CLAUDE.md Plans Discipline (no global plans) | Walk the git index for tracked plans paths; fail when found. |
no-toplevel-docs-grep | standalone | single-source-of-truth (docs live in site/, not root docs/) | Fail when a top-level docs/ directory exists at the repository root. |
oidc-trusted-publishing-grep | standalone | OIDC trusted publishing | Verify release workflows use OIDC trusted publishing. |
option-annotation-grep | per-write | M7 option-annotation (H6 per-option bind) | Enforce the per-option Recommended label-to-body bind (H6). |
orphan-output-grep | per-write | M12 canonical-layout + M14 systemicity | Flag artifacts emitted to non-canonical locations or without provenance. |
permissions-minimum-scope-grep | standalone | minimum-scope workflow permissions | Verify every GitHub Actions workflow declares a minimum-scope permissions: block. |
plain-language-grep | standalone | rules/plain-language.md — user-facing prose | Flag mechanistic / harness-internal vocabulary in user-facing prose. |
plan-next-step-consistency-grep | standalone | rules/recommend-next-step.md | Advisory: flag plan-suite infra files whose Recommended-Next-Step footer drifts from the suite's recorded next pipeline stage. |
plan-suite-structure-grep | standalone | context-management-scratch 2 (suite-locality + closed vocab) + canonical-layout-reporting-tiers 2.1 (numeric-prefix discipline) | Validate plan-suite structure: suite-locality, closed vocab, numeric prefix. |
plans-discipline-language-grep | standalone | CLAUDE.md Plans Discipline (multi-surface language) | Verify the canonical Plans Discipline language reaches every required surface. |
production-ready-pr-grep | per-write | M15 production-ready §Same-change-set | Flag commits whose change-set lacks the production-ready four-class shape. |
recommend-next-step-grep | standalone | rules/recommend-next-step.md | Verify every command file carries a ## Recommended Next Step block. |
redundancy-grep | standalone | rules/operational-mandates.md §CM-7 coherent-product non-redundancy | Flag substantively-duplicated paragraphs across the governed corpus. |
reference-token-grep | standalone | rules/own-voice-reimplementation.md | Flag leaked reference-platform branding tokens on authored surfaces. |
registry-capability-consistency-grep | standalone | rules/agent-capability-discipline.md — registry capability cells backed by evidence | Flag registry capability cells not backed by install / materializer / projection evidence. |
secret-leak-grep | per-write | M13.8 security + M15 production-ready | Block emission of artifacts containing hardcoded credentials. |
semver-stability-grep | change-set | M15 semver-stability | Semver stability matcher (M15 mechanical fraction). |
smoke-install-grep | standalone | production-ready section 8.1 paired install scripts | Smoke-test the paired install scripts at the repository root. |
static-version-grep | standalone | rules/dynamism.md §static-version-resolution | Verify version-bearing sites resolve dynamically, not as static literals. |
token-efficiency-grep | per-write | clean-room-generation §5 + token-efficiency-rewrite | Flag filler phrases, throat-clearing openers, and content-free qualifiers. |
unpinned-action-grep | per-write | M15 production-ready §Supply-chain | Flag GitHub Actions workflows that pin actions to mutable refs. |
user-confirm-grep | per-write | M5 authority-inquiry §10 | Block emission of artifacts containing unresolved authority placeholders. |
workflow-concurrency-grep | standalone | workflow concurrency + per-job timeouts | Enforce concurrency + per-job timeout discipline on GitHub workflows. |
Executar o portão
Em um harness instalado, o portão é executado automaticamente: o
settings.json do Claude Code o conecta como um hook PreToolUse que invoca a
cópia materializada em ~/.claude/.apothem/support/conformity/gate.py antes de
cada Write/Edit. O portão então verifica apenas as gravações dentro do escopo do
seu hook, e uma gravação fora do escopo passa em silêncio; Executar o conformity gate
lista o escopo. A partir de um checkout do código-fonte, a forma de módulo
executa o mesmo código; prefixe cada comando python abaixo com
PYTHONPATH=src. O portão é consultivo por padrão: ele relata os achados e sai
com 0. Adicione --strict para sair com 2 diante de um achado bloqueante. Um
nome de validador desconhecido sai com 3.
# Every standalone validator across the repository:
python -m apothem.conformity.gate --all .
# The same sweep, failing on a blocking finding (the CI form):
python -m apothem.conformity.gate --all --strict .
# Every per-write validator against every tracked file:
python -m apothem.conformity.gate --all-perwrite .
# One validator by name (names come from --list):
python -m apothem.conformity.gate --check naming-grep .
# List every registered validator as JSON:
python -m apothem.conformity.gate --list
# Single-file dispatch (mimics the PreToolUse hook):
echo '{"tool_input": {"file_path": "path/to/file", "content": "..."}}' \
| python -m apothem.conformity.gate --hookpython -m apothem.conformity.gate --help imprime o resumo de uso.
Consulte Executar o conformity gate para o procedimento completo.
Referência
- Registro do portão de pré-emissão — definições canônicas das barras
- Registro de conformidade externa — semântica detalhada de M1-M15
- Mandatos transversais — fonte da verdade dos mandatos
- Disciplina de desempenho — orçamentos de tempo de execução por classe
Varredura de artefatos binários
Varredura de artefatos binários do Apothem — zero binários compilados / empacotados rastreados no código-fonte. Evidência da verificação Binary-Artifacts do OpenSSF Scorecard.
Runbooks
Runbooks do Apothem — procedimentos operacionais passo a passo para lançamentos, configuração de publicador, habilitação do Pages, recuperação e criação de adaptadores.