Versions

How MedGauge is updated

Every object MedGauge publishes carries a version. This page sets out, for each kind of object, how it is versioned, who approves a change, how often it is reviewed, and where the change is published. It follows the MedGauge Methodology, version 0.1.0, sections 14.4, 17, 22, 27 and 29–32. Where the methodology sets no rule, the entry reads not set.

Versioned objects

ObjectVersioningApprovalReviewPublished in
Methodologymajor.minor.patch, by change classRequest for comment and pull request; two maintainersAfter every holdout round and in any case once every twelve months; each review ends in an Appendix D entry, either no change or a versioned changeChangelog; Appendix D of the methodology; a site-wide notice for a non-comparable change; a persistent identifier and a preprint at publication
Chartermajor.minor.patchPull request with a version increment; two maintainersNot setChangelog; the charter file in the repository
Schemas and validator rulesWith the methodology version, which each schema carries in its $idNot set separatelyWith the methodologySchemas page; changelog
Benchmark versionmajor.minor.patch per family; frozen and never editedGates 1–11 and independent acceptance; an independent acceptor and one maintainerKeys audited after every round; a key found wrong is corrected in the next versionBenchmark card; changelog; a non-comparability notice on every affected board; a persistent identifier per frozen version
Registry recordversion field and introduced_in; dates introduced and last reviewedPull request with schema and reference checks; one maintainerGrading references: see below. Other records: not setThe registry pages; registry JSON; changelog
Grading reference listingversion field; a correction links its predecessorSecond-person clause check on the original and the conformant-alternative test; a reference engineer and one reviewerAt every freeze of a version that uses it, whenever the source publishes a revision, and in any case within twelve months of the previous checkReferences pages; changelog
Harness, tool, componentOne immutable file per versionSchema; adapter check or smoke test; scope declaration; one maintainerMarked deprecated after two consecutive benchmark versions without a result record, or on its maintainer’s request; its page staysRegistry pages; changelog
Result recordSite-verified; never editedSite run or site re-grade and the review checklist; a results reviewer and one maintainerNot setLeaderboard and benchmark card; changelog for corrections and retractions
Difficulty functionmajor.minor.patch, cited as difficulty-function@<version>; a frozen version keeps the function in force when it frozeCut points: request for comment, non-comparable change, site-wide notice; two maintainersWith the methodologyMethodology Appendix A; changelog
Level rules and thresholdsWith the methodology version; no threshold is set in 0.1.0Request for comment, non-comparable change, site-wide notice; two maintainersWith the methodologyMethodology Appendix B; changelog
Price tableVersion; published with the results that use itNot setNot setWith the result records that use it
Methodology articleDate; supersedes linkNot setAn article that cannot meet the evidence grade it carries is regradedMethodology articles; changelog

Every change to the public repository is a pull request that passes the build checks: schema validation, cross-references, internal links, English-only text and the red-line scan. A dispute on any decision above is settled by three independent votes, and the outcome and reasons are published.

Change classes

Non-comparable
Any change that alters a published number or a level: aggregation rules, thresholds, difficulty cut points or components, check semantics, the scale of a reported quantity. It carries a site-wide notice; results under the versions before and after it are labelled not comparable; earlier figures stay published under their own version. From version 1.0.0 it takes a new major version.
Below 1.0.0
While the methodology is in the 0.x series, its major number stays 0 and a non-comparable change takes a new minor version, with the same notice and labelling. A 0.x minor version may therefore be non-comparable; its changelog entry says so.
Minor
Additions that alter no published number: new sections, new contribution units, new registries, new gates applying to future versions, new subject kinds.
Patch
Wording, references, examples.

A change takes effect at the next benchmark version freeze, unless it is a patch, and is recorded in Appendix D of the methodology.

Twelve-month review

Non-comparability

A change of benchmark version, difficulty function version or level threshold, and a methodology version that makes a non-comparable change, produce a notice on every affected board. Earlier figures stay published under their own version, and no figure is pooled or totalled across versions.

Corrections and retractions

To report an error, name the page or record and the field; see Contact. Problems with a key or a grading reference name the benchmark version or reference id, the field and the source clause.

Following changes

Changelog
/changelog/, newest first
Atom feed
/changelog.xml, the changelog as a feed, generated when the site is built
Sitemap
/sitemap.xml
Registry export
/api/v1/registry.json
Build stamp
Every page names the registry commit it was built from, in the footer
E-mail
There is no mailing list.

Persistent identifiers

Each methodology version, each frozen benchmark version, each round report and each release of the public repository receives a digital object identifier through the repository's archive integration; the repository's CITATION.cff carries the current identifier. Methodology versions and round reports are also deposited on a public preprint server at publication. A result is cited with its four-tuple (model, harness and version, benchmark version, date); a level with its four-tuple and the methodology version.