Contributing
The most useful contribution is a file that OpenReadout reads wrongly or not at all. Run openreadout check --report FILE and attach the bundle it writes to a new-variant issue. For code changes, read CONTRIBUTING.md and the clean-room policy first.
Maintainer documentation
- Maintaining OpenReadout: how a failing file becomes a validated variant, and the assets a new maintainer relies on.
- Architecture: crates, traits and the rules every reader follows.
- Assurance: how the per-file assurance and the evidence page are derived.
- Release process.
- Clean-room policy.
- Provenance logs: how each reader was derived, file by file.
- Format notes: byte layouts and vocabulary tables.
- Benchmarks: held-out and second-opinion comparisons.