From 980b16732719608e6192bba39badaf4b0fa4d293 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Tue, 16 Jul 2024 20:07:41 -0400 Subject: [PATCH] Clarify dataset inclusion process (#200) --- docs/custom_datasets.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/custom_datasets.rst b/docs/custom_datasets.rst index 11e4c056..b3945484 100644 --- a/docs/custom_datasets.rst +++ b/docs/custom_datasets.rst @@ -113,7 +113,14 @@ Here is an example animation generated from a custom dataset: (Optional) Contribute the dataset --------------------------------- -If you have the rights to distribute the dataset and you think it would be a good -inclusion as a built-in dataset, make a PR to add it to Data Morph. Be sure to consult -the `contributing guidelines `_ +If you have the rights to distribute the dataset and you think it would +be a good built-in dataset, `create an issue `_ +in the Data Morph repository proposing its inclusion. Be sure to consult the +`contributing guidelines `_ before doing so. + +If and only if you are given the go ahead: + +1. Add your CSV file to the ``src/data_morph/data/starter_shapes/`` directory. +2. Add an entry to the ``DataLoader._DATASETS`` dictionary in ``src/data_morph/data/loader.py``. +3. Submit your pull request.