Skip to content

Commit db91898

Browse files
Merge pull request #246 from scverse/LucaMarconato-patch-1
Update README.md
2 parents 82ff327 + df80497 commit db91898

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,21 @@ This package contains reader functions to load common spatial omics formats into
2727

2828
Note: all mentioned technologies are registered trademarks of their respective companies.
2929

30+
## Known limitations
31+
32+
Contributions for addressing the below limitations are very welcomed.
33+
34+
- Only Stereo-seq 7.x is supported, 8.x is not currently supported. https://github.com/scverse/spatialdata-io/issues/161
35+
36+
### How to Contribute
37+
38+
1. **Open a GitHub Issue**: Start by opening a new issue or commenting on an existing one in the repository. Clearly describe the problem and your proposed changes to avoid overlapping efforts with others.
39+
40+
2. **Submit a Pull Request (PR)**: Once the issue is discussed, submit a PR to the `spatialdata-io` repository. Ensure your PR includes information about a suitable dataset for testing the reader, ideally no larger than 10 GB. Include clear instructions for accessing the data, preferably with a `curl` or `wget` command for easy downloading.
41+
42+
3. **Optional Enhancements**: To facilitate reproducibility and ease of data access, consider adding a folder in the [spatialdata-sandbox](https://github.com/giovp/spatialdata-sandbox) repository. Include a `download.py` and `to_zarr.py` script (refer to examples in the repository) to enable others to reproduce your reader by simply running these scripts sequentially.
43+
44+
3045
## Getting started
3146

3247
Please refer to the [documentation][link-docs]. In particular, the

0 commit comments

Comments
 (0)