bids-schema

A repository of BIDS schema versions (including historical versions), that could potentially be used by schema-driven validators supporting multiple versions.

Note that schema syntax and validator capabilities keep rapidly evolving. Eventually, this repository might become the authoritative BIDS schema resource, including all released versions, but ATM it is AFAIK not used directly. Potentially, it could be used as a git submodule in the repositories of tools which need to use it, incorporated into their tree (fully or partially) via the git subtree mechanism, or distributed separately by package managers.

• The live BIDS schema, as used for all development work, will continue to reside within the bids-specification repository in order to streamline the addition and testing of changes.

• On a regular basis (via cron or push notifications from the bids-specification master branch) this repository should use e.g. git subtree to extract the current schema version and add it to its index.

• The layout of files:

  • LICENSE
  • README.md
  • versions/
    • x.y.z/ - subdirectories matching schema versions in the BIDS specification
    • latest/ - a copy (symlinks aren't supported on some operating systems) of the most recent release
    • master/ - the state of schema in the BIDS specification master branch repository
  • PRs/ - schemas from Pull Requests with schema changes
  • BEPs/ - schemas for BIDS Extension Proposals
  • tools/

Schema Versions

Schema versions are automatically updated using CI run.

Released Versions

• Latest Release - Current stable BIDS schema
• All Releases - Historical BIDS schema versions

Development Versions

• Master Branch - Current development schema
• PR Schemas - Schemas from open Pull Requests with schema changes
• BEP Schemas - Schemas for BIDS Extension Proposals

See PRs/README.md and BEPs/README.md for detailed status tables.

HOWTOs

git subtree

See http://github.com/dandi/dandi-core and its README.md for an example of similar (not yet fully automated) subtree use.

Contributions

See AGENTS.md for more information and guidance for contributions.

References

• bids-specification #466 the issue discussing establishing of schema for BIDS

Major TODOs

• Add rendering of PRs and BEPs