Contributing

Contributions to the mzTab-M specification, schema, tooling, and documentation are welcome.

Reporting Issues

Use the GitHub issue tracker to report bugs, ask questions, or propose changes to the specification. Please include a minimal mzTab-M file that demonstrates the issue where applicable.

Proposing Specification Changes

Specification changes are discussed as GitHub issues before any pull request is opened. Changes that affect the field definitions or controlled vocabulary requirements require review by the PSI metabolomics working group.

  1. Open an issue describing the proposed change and its motivation.

  2. Reach consensus with the working group (allow at least two weeks for discussion).

  3. Submit a pull request that updates specification_documents/mzTab_format_specification_2_1-M.adoc and schema/mzTab_2_1-M.json together.

  4. Update or add example files in examples/ to demonstrate the change.

Contributing to the Documentation

Documentation source files are AsciiDoc pages under docs/mztabm/modules/. The site is built with Antora; see mzTab-M for Developers for the tooling setup.

To preview your changes locally, run:

./build-site.sh

Code of Conduct

All contributors are expected to follow the Contributor Covenant code of conduct.