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

docs: Add experimental directory #635

Merged
merged 3 commits into from
Apr 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions kedro-datasets/experimental/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Experimental contributions
This directory is meant for `experimental` dataset contributions. These are datasets that are more experimental compared to the regular datasets in `kedro_datasets` and may not fully adhere to the usual standards.
This space allows for the inclusion of datasets that are in the early stages of development or might not meet the criteria for being part of the core Kedro datasets. As such, these datasets
are not maintained by the Kedro TSC, but will have been reviewed to ensure the dataset is usable.

These datasets do not have to be fully documented but must have doc strings that explain the use of the dataset. These datasets don’t run as part of the regular CI/CD jobs.

To contribute an experimental dataset, follow the guidelines in [the datasets contribution guide](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-datasets/CONTRIBUTING.md).