Contributing

Larmor is developed on GitHub, in the repository larmor-dmri/larmor.

• Reporting a problem or asking a question: open an issue in the repository. For a problem, say what you ran (the command or the Python code), what you expected, what happened, and which version of Larmor and which operating system you used.

• Proposing a change: open an issue first, so that the change can be discussed before work starts, then a pull request. The repository’s docs/contributing.md describes the workflow, with the code style (docs/style.md), the tests and the checks a pull request passes.

Every change comes with tests, and every user-facing feature with an example in the gallery. Contributions are distributed under Larmor’s licence.