Governance
Use this page to know what to expect before you put effort into a contribution.
Repositories
Section titled “Repositories”| Repository | Holds | Where to contribute |
|---|---|---|
openmvis/openmvis | the MVIS toolbox (code, tests, docs) | issues and pull requests |
openmvis/mvis_pages | this site | issues and pull requests; dataset offers |
openmvis/calibench-submissions | leaderboard submissions | issues while submissions are paused; see Submit results |
calibench-vi/datasets and calibench-vi/community on Hugging Face | the recordings | see Submit a dataset |
calibench-vi/results on Hugging Face | the leaderboard records | written by us only |
Maintainers
Section titled “Maintainers”- 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.
How contributions are reviewed
Section titled “How contributions are reviewed”| Contribution | What we check |
|---|---|
| Code | correct behaviour, a test that fails before and passes after, the CI tiers pass, no unintended change in benchmark results |
| Documentation | the facts are right and the page stays its type (see below) |
| Dataset | format, dataset card, licence, no private content (see Submit a dataset) |
| Results | the 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 unitandscripts/test.sh solver. Runscripts/test.sh fullbefore 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.
Page types on this site
Section titled “Page types on this site”Each page declares a pageType in its frontmatter and keeps to it:
| Type | Contains | Does not contain |
|---|---|---|
tutorial | one ordered path from start to result | alternatives, options, theory |
guide | the steps for one task | derivations (link to a concept page) |
concept | explanation, maths, figures | commands (link to a guide) |
reference | complete lists, one anchor per entry | narrative |
example | a real run, with its checks | concepts 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.
Licence of contributions
Section titled “Licence of contributions”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.
Conduct
Section titled “Conduct”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.
Security problems
Section titled “Security problems”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.
Credit
Section titled “Credit”- Code contributors are listed in the
AUTHORSfile ofopenmvis/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.