Developer guide

Developer guide#

Repository development, contribution and release procedures.

Page

Scope

Development prerequisites

Git, Python, native toolchain and submodules.

Editable installation

Editable installation and development dependencies.

Development workflow

Fork-based development, branches and pull requests.

Coding style

Ruff, formatting, tests and code conventions.

Documentation

Documentation types, scientific writing and gallery policy.

Terminology and conventions

MRI, Pulseq, units, coordinate frames and safety language.

Pre-commit

Local hooks, deliberate bypasses and CI.

Pull requests

Pull-request contents and validation.

Code of conduct

Project participation policy.