Contributor guide¶
Contributions that improve correctness, scientific clarity, accessibility, tests, examples, or documentation are welcome. The application and manual are maintained in separate repositories:
| Repository | Scope |
|---|---|
napari-vipp |
Application, operation registry, examples, tests, release metadata |
vipp-mkdocs |
Public, versioned user manual |
Publication plans, private datasets, ethics material, unpublished results, and internal screenshot roadmaps do not belong in either public manual page.
Pick a contribution path¶
- Understand architecture and scientific boundaries
- Set up a development environment
- Add or change an operation
- Test and document changes
- Publish versioned documentation
Principles¶
- Correctness before breadth. A smaller validated node is preferable to a broad claim with unclear behavior.
- Metadata claims are field-specific. State exactly which axes, scale, units, channels, or history are transformed or retained.
- Graph examples must be executable. Core JSON examples use bundled deterministic samples and have focused assertions.
- UI labels and docs move together. Search the manual for changed labels, defaults, node titles, formats, and version references.
- Scientific limitations are user-facing behavior. Put material caveats beside the task, not only in an internal roadmap.
Before opening a pull request, describe the user-visible outcome, tests run, scientific assumptions, compatibility impact, and documentation changes.