Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.84 KB

Contributing

EVERYTHING RINGS combines a consumer acoustic instrument with empirical measurement, research, provenance, and validation infrastructure. Contributions are welcome, but changes must preserve the distinction between product behavior, research diagnostics, and evidence-eligible empirical contracts.

Development setup

Use the repository-declared pnpm version and frozen lockfile:

corepack enable
pnpm install --frozen-lockfile
pnpm typecheck
pnpm test
pnpm build
bash scripts/browser-smoke.sh

Change classes

Product-only changes

Consumer UI, local history, sharing, visualization, and other non-empirical features belong on the product development line. They must not be merged into a frozen empirical authority revision solely for convenience.

Research/diagnostic changes

Alternative DSP configurations, digital twins, external datasets, similarity baselines, material/spatial models, and future embeddings must clearly state whether their output is evidence-eligible. Custom analysis configurations must not claim an er-dsp-* canonical algorithm version unless a new algorithm contract is explicitly versioned.

Empirical-contract changes

Changes to acquisition semantics, DSP parameters, evidence schemas, campaign design, gate thresholds, review-plan selection, or Release Console authority require explicit versioning and requalification before new physical evidence is accepted. Do not relax a frozen threshold or omit a failed observation to make an observed dataset pass.

Pull requests

A pull request should state:

  • the intended change class;
  • which claim or product behavior changes, if any;
  • whether evidence semantics change;
  • tests added or updated;
  • whether a prior empirical revision must be superseded or requalified.

Keep machine contracts, documentation, and advertised claims synchronized. A nearby or weaker theorem/test must not be presented as evidence for a stronger proposition.

Privacy

Do not commit microphone PCM, private Gate B listening companions, secrets, user-private artifacts, or device identifiers that should remain local. Synthetic/digital-twin signals are acceptable when clearly labeled non-physical.

Public Atlas artifacts must satisfy their versioned privacy and consent contracts. A content digest proves byte identity; it does not prove that an asserted physical-object identity or material label is true.

Licensing

The software repository is licensed under the MIT License. Unless a contribution explicitly states otherwise and is accepted under separate terms, software contributions are made under the same license.

Datasets, trained models, benchmark corpora, media, and future physical-corpus artifacts may carry separate licenses or usage terms. The repository's MIT software license does not automatically grant rights to separately identified data or third-party content.