Skip to content

Governance

Use this page to know what to expect before you put effort into a contribution.

RepositoryHoldsWhere to contribute
openmvis/openmvisthe MVIS toolbox (code, tests, docs)issues and pull requests
openmvis/mvis_pagesthis siteissues and pull requests; dataset offers
openmvis/calibench-submissionsleaderboard submissionsissues while submissions are paused; see Submit results
calibench-vi/datasets and calibench-vi/community on Hugging Facethe recordingssee Submit a dataset
calibench-vi/results on Hugging Facethe leaderboard recordswritten by us only
  • Who: the maintainers are listed on Contributors.
  • What they do: review and merge pull requests, run the benchmark, host the datasets and make releases.
  • Releases: only maintainers can create release tags. A tag builds the package and publishes it to PyPI after a maintainer approves it.
  • Support: MVIS is research code, maintained on a best-effort basis.
ContributionWhat we check
Codecorrect behaviour, a test that fails before and passes after, the CI tiers pass, no unintended change in benchmark results
Documentationthe facts are right and the page stays its type (see below)
Datasetformat, dataset card, licence, no private content (see Submit a dataset)
Resultsthe configs, outputs and provenance needed to reproduce them (see Submit results)

CI (the checks that run automatically on GitHub) tests what it can. A maintainer reviews the rest.

For code, read CONTRIBUTING.md first. In short:

  • One topic per pull request, with a test that fails before the change and passes after it.
  • Keep CI green: scripts/test.sh unit and scripts/test.sh solver. Run scripts/test.sh full before you ask for a merge. See Regression testing.
  • Licence header: new source files start with the same licence header as the files in src/. A test checks it.
  • Bug reports: include the config YAML, the full log, mvis --version, your operating system and Python version, and a link to the data if you can share it.

Each page declares a pageType in its frontmatter and keeps to it:

TypeContainsDoes not contain
tutorialone ordered path from start to resultalternatives, options, theory
guidethe steps for one taskderivations (link to a concept page)
conceptexplanation, maths, figurescommands (link to a guide)
referencecomplete lists, one anchor per entrynarrative
examplea real run, with its checksconcepts introduced for the first time

When a page drifts, split it instead of mixing the two types:

  • A guide that starts explaining means a concept page is missing.
  • A concept page that starts giving commands means a guide is missing.

We review documentation pull requests against this table.

A pull request to openmvis/openmvis comes with the contributor terms in CONTRIBUTING.md: you keep the copyright, and grant the copyright holder the right to offer your contribution under the commercial licence too. How the code, datasets and results are licensed: License.

Be civil and assume good faith. We do not accept:

  • harassment
  • personal attacks
  • submissions made in bad faith

Maintainers may close issues, reject contributions and restrict participation when these rules are broken. Report a problem to contact@openmvis.com.

Do not open a public issue for a security problem. Email contact@openmvis.com with the affected version (mvis --version), the steps to reproduce and, if you have one, a fix. We acknowledge reports within a week. The full policy is in SECURITY.md.

  • Code contributors are listed in the AUTHORS file of openmvis/openmvis.
  • Datasets we host get:
    • a citation entry in the dataset card
    • a named entry on Contributors
    • where we calibrate it, a page for the rig in the Device wiki with the results
  • Security reports are credited in the changelog unless you ask us not to.