Transaction-Science/open-standards
Watch
1
0
Fork
You've already forked open-standards
 0
Code Issues Pull requests Projects Releases 15 Packages Wiki Activity Actions 5
open-standards/CHARTER.md
Transaction Science 60eab96364 ci: no-vanity-metrics scanner + pre-commit hook + CHARTER policy 
Wires the no-vanity-metrics policy from prose-only into structural
enforcement. Without this, the next time a count creeps into a
README it stays there until I notice; with this, the PR fails.

What lands:

  - scripts/check-no-vanity-metrics.sh — bash scanner, dep-free,
    targets marketing/spec/governance Markdown only (per-phase
    progress docs, CHANGELOGs, conformance/notes/research dirs
    exempt by design). Regex is tuned to the patterns we've actually
    had to fix and rejects false positives on RFC / codec / version
    references. Lines that legitimately need a number opt out with
    `<!-- allow-vanity: <reason> -->`.
  - .github/workflows/no-vanity-metrics.yml — CI workflow runs the
    scanner on every PR and `main` push that touches Markdown.
  - .githooks/pre-commit — same scanner, local guard so the failure
    happens before push. Activated per-clone via
    `scripts/install-hooks.sh`.
  - CHARTER.md — adds a "Messaging — no vanity metrics" section
    documenting the policy and pointing to the scanner.

Also strips the four remaining drift sites the scanner found on
first run: a ~5 LOC stub note, a "98 crates" + "≤ 120 LOC" mention
in jouleclaw-stack/examples/AGENTS.md, and "26 crates" in the PCI
scope-map doc. The CAMT.054 ISO 20022 message-name reference is
preserved via an allow-vanity marker.
2026-06-02 10:39:43 -04:00

3.4 KiB
Raw Permalink Blame History

Charter — Transaction Science Open Standards

This charter describes the stewardship pattern that applies to every standard published in this repository. It is short on purpose. The protocols themselves carry the substance; this document captures the operating principles around them.

The pattern

Each standard in this repository is published under an open licence — Apache-2.0 for code, CC-BY-4.0 for specification text — and is owned by no one. Transaction Science writes the reference implementation, runs the optional hosted services, and stewards the conformance vectors. The wire format and the right to fork are public.

This is the difference between the protocol and the offer:

  • The protocol is what anyone can implement. It is free, in both senses of the word.
  • The offer is what Transaction Science sells: managed deployments of the reference implementation, driver development against the public traits, persistence backends, custody integrations, certification engagement, and the operational scaffolding around real-world deployments.

The protocol does not tax money movement, message movement, or compute movement. The optional services are the revenue.

Versioning

Each standard versions independently. Tags follow openpay-v0.1.0, smart-byte-v1.0.0-draft.1, eoc-v0.2.0, etc. — the prefix is the subdirectory name. A change in one standard does not bump the others.

Conformance

A standard is conformant if it round-trips the published wire vectors. The vectors live under each subdirectory and are signed at release time. Reference implementations are conformant by construction; third-party implementations certify themselves by running the public test suites.

What this charter does not say

  • It does not assign exclusive authority. Anyone may fork, and a fork is no less legitimate for being a fork.
  • It does not promise a release cadence. Standards advance when the work is done.
  • It does not bind future standards to current ones. A standard added later is bound only by its own conformance vectors and the open-licence requirement.

Adding a standard

A new standard joins this repository by:

  1. Landing in a new top-level subdirectory.
  2. Carrying its own README, LICENSE, and (where applicable) CONTRIBUTING.md.
  3. Being added to the table in the root README.md.
  4. Inheriting the operating principles in this charter.

Messaging — no vanity metrics

Codebase-state numbers (N crates, N tests passing, N LOC, N+ adapters) drift on every code change and create permanent sync debt between the website, the GitHub READMEs, and any downstream messaging. Marketing surfaces in this repository describe the shape of what's there, not the size. Spec versions, algorithm names, RFC numbers, license labels, and other identity-class facts are preserved — they are part of the contract.

A scanner enforces this: scripts/check-no-vanity-metrics.sh, run on every PR and main push by the no-vanity-metrics CI workflow. Contributors can wire it into a local pre-commit hook via scripts/install-hooks.sh. The scanner targets marketing / spec / governance Markdown; historical progress notes, changelogs, and external corpora are exempt by design. Lines that legitimately need a number (a reference to an external spec, codec, or RFC) opt out with <!-- allow-vanity: <reason> --> at end of line.