Contributing#

Corrections, new measurements, new calculations, new materials, better models and documentation fixes are all welcome.

Choose the workflow for your change:

  • Report a problem with a value with the report form: which value, what you expected, and what you compared against (a paper with its table or page, an independent calculation), at what conditions. A suspected misprint in a paper is just as welcome. A propagation that goes wrong with the right values belongs with solprop.

  • Offer a paper or data that optmat lacks with the source form; Papers and data we are looking for lists what would help most.

  • Plan work in an issue. CONTRIBUTING.md says what to check first, the sections to use and the labels.

  • Add or correct data through a source record, an extraction script that writes the values exactly as printed, errata with their evidence for any misprint, and an entry in the review register (The review register). The format is on The curated data; the workflow is in Adding sources and materials.

  • Change a model or a fit by editing its configuration, re-running the fit and its leave-one-out robustness record, updating the pages whose tables are tested against the stored fits, and recording the decision, with the numbers behind it, in the register.

  • Propose a major change as an enhancement proposal (OEP):

    • a new medium, family of properties or kind of curated value;

    • a changed default or convention;

    • a redesigned interface.

    An OEP sets out the theory, the primary sources, the options and the verification plan. It is reviewed by at least one human and one frontier AI model before it is accepted, and it records its implementation phase by phase.

Every change passes the full gate, uv run poe check: lint, format, types, docstrings, spelling, copyright and licence (reuse lint), the tests with 100 % statement and branch coverage of the package, and this manual’s build. The coverage scope and additional verification lanes are described on Development checks. Documentation-only changes use the shorter gate specified in the working rules. Work on a topic branch in its own worktree; agents create both without asking. Concurrent register entries are reconciled before integration as described on Maintaining the review register. Contributions are licensed under the project’s MIT licence.