Skip to content
Apothem
Conformity gate

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

BarraIDMandatoClasse de verificaçãoFalha → ação
1M1Agnosticismo quanto ao projeto anfitriãoRaciocinadaRevisar para seguir as convenções do anfitrião
2M2Disciplina editorial (livro-razão de divulgação)RaciocinadaAdicionar marcadores de divulgação
3M3Dez dimensões de qualidadeMecânica + raciocinadaRevisar nas dimensões que falham
4M4Autoaplicação (bloco de verificação presente)RaciocinadaRegistrar o bloco de verificação
5M5Princípio de autoridade (nenhuma identidade / endpoint / segredo fabricado)MecânicaEncaminhar para consulta
6M6Incorporação de expertise (lacunas expostas)RaciocinadaExpor lacunas; citar refinamentos
7M7Anotação de opções (marcador Recommended + justificativa do fator determinante)MecânicaAnotar os conjuntos de opções
8M8Definitividade (nenhuma hesitação na prosa prescritiva)MecânicaConverter hesitações em condicionais
9M9Alavancagem visual (temas estruturais trazem diagramas)Mecânica + raciocinadaCriar / atualizar o diagrama
10M10Vinculação bidirecional (ponteiros de retorno recíprocos fechados)MecânicaFechar as meias-arestas
11M11Sprints ágeis (Objetivo / Backlog / DoR / DoD / Revisão / Retrospectiva)RaciocinadaReestruturar como sprints
12M12Relatórios de fase e disposição canônicaMecânica + raciocinadaRedigir o resumo; realocar para a disposição canônica
13M13Ofício de código (lint / formatação / verificação de tipos; número mágico; bare-except)MecânicaAplicar as regras de ofício de código de cada linguagem
14M14Sistemicidade (declara montante / jusante / pares / aplicadores)Mecânica + raciocinadaDeclarar; indexar nos registros
15M15Pronto para produção (testes + documentação + CHANGELOG + commit conforme + CI em verde + estabilidade semver)Mecânica + raciocinadaAdicionar 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.

ValidatorRunsRule anchorWhat it checks
agent-capability-grepstandaloneagent-capability-discipline (per-harness capability matrix)Verify every harness declares its agentic-capability matrix.
agents-md-coverage-grepstandalonerules/agents-md-convention.mdFlag stale agent-companion files under the root-only AGENTS.md convention.
agnosticism-grepstandalonerules/agnostic-posture.md §3 (harness neutrality) + §1 (default-off)Flag harness bias and re-introduced enforcement presets in shipped surfaces.
always-on-budget-grepper-writeD1 token-budget-discipline §Always-on body budgetBody-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-grepper-writeM13.3 error handlingFlag bare except clauses without typed exceptions or re-raise.
binding-five-direction-grepstandaloneM10 bidirectional-binding §1 (five-direction Bindings section)Require the five-direction Bindings section on every rule, command, agent, and skill.
binding-reciprocity-corpus-grepstandaloneM10 bidirectional-binding §2 (↔ self-reciprocal)Cross-file binding-reciprocity corpus walk — the ↔-symmetric half-edge check.
binding-reciprocity-grepper-writeM10 bidirectional-binding §NotationFlag binding declarations using non-canonical arrow notation.
brand-mark-grepper-writerules/plain-language.md (brand-mark display/identifier casing)Flag brand-mark display/identifier form drift on brand-touched surfaces.
commented-out-code-grepper-writeM13.1 why-not-what commentsFlag substantial commented-out code blocks left in source.
completion-claim-grepper-writerules/session-closure.md (verifiable-close output honesty)Flag unsupported completion / guarantee claims in cohort prose.
conventional-commit-grepstandaloneCLAUDE.md Coding Conventions — Conventional CommitsFlag HEAD commit messages that drift from the Conventional-Commits grammar.
copilot-instructions-presence-grepper-write—GitHub Copilot surface presence check.
cross-platform-matrix-grepstandalonecross-platform OS x Python CI matrixVerify CI declares a cross-platform OS x Python matrix.
determinism-grepstandalonerules/determinism.mdProve every command and skill surface has a deterministic output shape.
diagram-staleness-grepper-writeM9 visual-leverage §FidelityFlag diagrams whose verification date is missing or stale.
dynamism-grepstandalonerules/dynamism.md (static-version embeds)Flag static-string version embeds in dynamism-required surfaces.
editorconfig-presence-grepstandalonesupply-chain SOTA-rigor §editorconfigVerify a canonical .editorconfig is present at the project root.
file-header-grepper-write—Authorship-header presence and canonical-form check.
freshness-token-grepstandalonerules/freshness-facade.mdFlag freshness-narrative phrases on shipped public surfaces.
frontmatter-grepper-writethe per-class frontmatter JSON Schemas (src/apothem/schemas/)Validate per-artifact-class YAML frontmatter against required-key sets.
frontmatter-value-grepstandaloneper-class JSON Schema enum/pattern value constraintsValidate frontmatter VALUES against the per-class JSON Schema enum/pattern constraints.
gate-evidence-grepstandalonecommands/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-grepstandalonesupply-chain .gitattributes contractVerify the repo-root .gitattributes carries the canonical contract.
harden-runner-grepstandaloneharden-runner egress baselineVerify every workflow job opens with a conformant harden-runner step.
hedging-grepper-writeM8 definitiveness §HedgingFlag hedging vocabulary in prescriptive contexts.
license-author-consistency-grepper-write—LICENSE author-identity presence check.
link-checkper-writerules/code-craft-markdown.md §6 Link DisciplineValidate Markdown internal links against the on-disk reference graph.
magic-number-grepper-writeM13.10 magic numbersFlag magic numbers in source code.
multi-surface-coherence-grepper-write—Shared-claim coherence across AI-conventions surfaces.
naming-grepstandaloneCLAUDE.md Coding Conventions (kebab-case naming)Validate filesystem paths against the canonical naming convention.
no-global-plans-grepstandaloneCLAUDE.md Plans Discipline (no global plans)Walk the git index for tracked plans paths; fail when found.
no-toplevel-docs-grepstandalonesingle-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-grepstandaloneOIDC trusted publishingVerify release workflows use OIDC trusted publishing.
option-annotation-grepper-writeM7 option-annotation (H6 per-option bind)Enforce the per-option Recommended label-to-body bind (H6).
orphan-output-grepper-writeM12 canonical-layout + M14 systemicityFlag artifacts emitted to non-canonical locations or without provenance.
permissions-minimum-scope-grepstandaloneminimum-scope workflow permissionsVerify every GitHub Actions workflow declares a minimum-scope permissions: block.
plain-language-grepstandalonerules/plain-language.md — user-facing proseFlag mechanistic / harness-internal vocabulary in user-facing prose.
plan-next-step-consistency-grepstandalonerules/recommend-next-step.mdAdvisory: flag plan-suite infra files whose Recommended-Next-Step footer drifts from the suite's recorded next pipeline stage.
plan-suite-structure-grepstandalonecontext-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-grepstandaloneCLAUDE.md Plans Discipline (multi-surface language)Verify the canonical Plans Discipline language reaches every required surface.
production-ready-pr-grepper-writeM15 production-ready §Same-change-setFlag commits whose change-set lacks the production-ready four-class shape.
recommend-next-step-grepstandalonerules/recommend-next-step.mdVerify every command file carries a ## Recommended Next Step block.
redundancy-grepstandalonerules/operational-mandates.md §CM-7 coherent-product non-redundancyFlag substantively-duplicated paragraphs across the governed corpus.
reference-token-grepstandalonerules/own-voice-reimplementation.mdFlag leaked reference-platform branding tokens on authored surfaces.
registry-capability-consistency-grepstandalonerules/agent-capability-discipline.md — registry capability cells backed by evidenceFlag registry capability cells not backed by install / materializer / projection evidence.
secret-leak-grepper-writeM13.8 security + M15 production-readyBlock emission of artifacts containing hardcoded credentials.
semver-stability-grepchange-setM15 semver-stabilitySemver stability matcher (M15 mechanical fraction).
smoke-install-grepstandaloneproduction-ready section 8.1 paired install scriptsSmoke-test the paired install scripts at the repository root.
static-version-grepstandalonerules/dynamism.md §static-version-resolutionVerify version-bearing sites resolve dynamically, not as static literals.
token-efficiency-grepper-writeclean-room-generation §5 + token-efficiency-rewriteFlag filler phrases, throat-clearing openers, and content-free qualifiers.
unpinned-action-grepper-writeM15 production-ready §Supply-chainFlag GitHub Actions workflows that pin actions to mutable refs.
user-confirm-grepper-writeM5 authority-inquiry §10Block emission of artifacts containing unresolved authority placeholders.
workflow-concurrency-grepstandaloneworkflow concurrency + per-job timeoutsEnforce 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 --hook

python -m apothem.conformity.gate --help imprime o resumo de uso. Consulte Executar o conformity gate para o procedimento completo.

Referência

On this page