Skip to content

Commit 02a487d

Browse files
Update contributing guidelines for example data
Clarify instructions for providing example data and scripts.
1 parent 9d0f107 commit 02a487d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To contribute a reader and make code review efficient, we kindly ask for:
1717

1818
- the **specification** for the raw data: a link to a (ideally) _public_ resource describing how the data is organized, and/or, for a new version of an already supported technology, a changelog describing in detail which changes are introduced;
1919
- the **reader** itself: a Python function, generally supported by helper functions/classes/enums, that reads the raw data and returns a `SpatialData` object;
20-
- example **data**: preferably one or more (very) small _public_ datasets, with a permissive license, to represent the data across various versions and cover potential edge cases of the raw data format. Alternatively, scripts to easily download _public_ and licensed data.
20+
- example **data**: preferably one or more (very) small _public_ datasets, with a permissive license, to represent the data across various versions and cover potential edge cases of the raw data format. Alternatively (or preferably, in addition), scripts to easily download _public_ and licensed data.
2121
- **test** functions: to ensure that the reader parses the data correctly. If helper functions are used, they should also be tested.
2222

2323
### The specification
@@ -206,7 +206,7 @@ As a wrap-up, here is a checklist of the main points to consider when contributi
206206
- Example data
207207
- [ ] Provide (very) small public test dataset(s) (~100kB–10MB, preferred), licensed with a permissive license (e.g. CC BY 4.0)
208208
- [ ] Ensure dataset(s) cover edge cases of the format
209-
- [ ] In addition to the small dataset(s) (or if only large datasets are available), create scripts in `spatialdata-sandbox`:
209+
- [ ] In addition to the small dataset(s), consider creating scripts for downloading and converting a real dataset in `spatialdata-sandbox`:
210210
- [ ] `download.py` (fetch raw data → `data/`)
211211
- [ ] `to_zarr.py` (convert raw data → `data.zarr`)
212212
- [ ] Include `requirements.txt` (or add PEP 723 metadata to the scripts) for dependencies not included in `spatialdata`

0 commit comments

Comments
 (0)