scverse / scverse/napari-spatialdata

Add design schema for napari-spatialdata and interacting plugins

Open
#313 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
90
Forks
25
Avg merge
22m
Merged PRs (30d)
1

Description

As suggested by @rtubelleza, it would be useful to have a document explaining the design and interactions of the various napari-spatialdata classes. This, paired with instructions on how third party developers can interact with the napari-spaitaldata plugin, would facilitate adoption.

In the process, we may need to expose new public APIs, an example is this one: https://github.com/scverse/napari-spatialdata/issues/312.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the napari-spatialdata classes and their interactions, then read issue #312 for the possible public API requirement. Done means the repository contains a design document explaining the classes and plugin interactions, plus guidance for third-party developers, with any needed public APIs identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.