Skip to content

Commit b0c388b

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 8485b8e commit b0c388b

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/contributing.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Contributing guide
2+
23
This guide is written for:
34

45
- **spatial technology companies** that would like to add a reader for a new product, support a new version of an existing technology, or contribute with edits/bugfixes to one of the available readers
@@ -12,24 +13,36 @@ The rest of the document will be specific to `spatialdata-io`.
1213
## Adding a new reader
1314

1415
### The reader file
16+
1517
### Separating the constants from the reader logic
1618

1719
## Adding tests: small data vs real data
20+
1821
### When small test datasets are available
22+
1923
### When only real (large) data is available
24+
2025
#### The `download.py` script
26+
2127
#### The `to_zarr.py` script
2228

2329
## What to test
30+
2431
### Testing multiple versions
32+
2533
### Testing plotting capabilities
34+
2635
### Testing data integrity
36+
2737
### Testing auxiliary functions
2838

2939
## Bug tracking
40+
3041
- tracking bugs also outside spatialdata-io
3142
- tracking bugs also in spatialdata
3243

3344
# Limitations
45+
3446
## Unsupported technologies
35-
## Naming constistency across readers
47+
48+
## Naming constistency across readers

0 commit comments

Comments
 (0)