Developer guide

Developer guide#

Repository development, contribution and release procedures.

Page

Contents

Installation

Prerequisites, editable install, pre-commit hooks and documentation build

Workflow

Branches, pull requests, continuous integration and code of conduct

Coding style

Ruff, formatting, tests and code conventions

Documentation

Documentation types, writing rules and gallery policy

Terminology and conventions

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

Internals

Derivations and rules behind the explanation pages