REVIEW & REPRODUCIBILITY
Publication
standards.
A research artefact should make its question, evidence, method and limitations open to examination.
Release checklist
01Question & scope+
State the research question, operational setting, intended decision and boundaries.
02Maintainer & contributors+
Name the responsible maintainer and reviewers. Credit contributions under the agreed arrangements.
03Evidence & access+
Describe data sources, provenance, permitted use and quality limitations. Public examples use approved shareable or clearly labelled synthetic material.
04Reproducible method+
Record the protocol, dependencies, versions, parameters and instructions needed to inspect or repeat the work.
05Evaluation & limitations+
Define the baseline, evaluation design, assumptions, uncertainty, negative findings and conditions under which the method should not be used.
06Licence & ownership+
Identify the licence for every released component. Distinguish original work, dependencies and retained proprietary material.
07Contribution & conduct+
Document contribution guidance, review, conduct expectations and a private route for sensitive security concerns.
08Release & revisions+
Check technical claims, attribution, permissions and licensing before release. Keep substantive corrections, inconclusive experiments and version history visible.
Provenance record
Connect every output to its evidence, engine, version, method and evaluation context. Report confidence only where the method supports a defensible estimate.
View the documentation template
Research question: Maintainer and reviewers: Evidence source and permitted use: Input dataset version: Engine and software version: Recipe / protocol version: Parameters and evaluation design: Findings and limitations: Uncertainty / confidence basis: Licence and release version: