Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add tutorial on how to add new datasets #692

Closed
1 task
dkrako opened this issue Feb 22, 2024 · 1 comment
Closed
1 task

add tutorial on how to add new datasets #692

dkrako opened this issue Feb 22, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@dkrako
Copy link
Contributor

dkrako commented Feb 22, 2024

Description of the problem

Currently there is not a step by step guideline on how to contribute datasets to the dataset library.

Description of a solution

Although the contributing.md is a good place to start adding this information, I think it would be best to link from there to a tutorial in our readthedocs page.

The CONTRIBUTING.md could include a link and maybe some more broad description, that we provide a metalibrary of downloadable datasets which are not hosted / provided by us but downloadable via pymovements. More general advices could also be included, like that a fork needs to be created if there's no invite for developing privileges yet.

What the CONTRIBUTING.md could also include is how to test the dataset via tox:

tox -e integration -- tests/integration/public_dataset_processing_test.py::test_public_dataset_processing[PoTeC]

Minimum acceptance criteria

  • add dataset contribution step by step guide to CONTRIBUTING.md
@SiQube
Copy link
Member

SiQube commented Aug 22, 2024

I close this in favour of #379 (duplicate). we also have to think about this when merging #771

@SiQube SiQube closed this as completed Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants