Thank you for your interest in contributing to YData Academy!
This repository is a community-driven collection of tutorials and use cases built with the ydata-sdk.
Whether you're improving documentation, fixing bugs, or adding new notebooks, your contribution is valuable.
There are many ways to help improve this project:
- ✍️ Improve documentation or notebook readability
- 🧪 Add new use cases or examples using
ydata-sdk - 🛠 Fix issues or bugs in the code examples
- 🧹 Refactor or clean up existing notebooks
- 🧭 Suggest new topics or improvements via GitHub Issues
Before contributing, please make sure you follow these simple rules:
- All code examples should use the latest version of
ydata-sdk. - Keep notebooks modular and focused on a specific capability or use case.
- When adding a new notebook, place it in the appropriate folder and use a consistent naming format (e.g.,
01_synthetic_timeseries.ipynb). - Document assumptions, steps, and key insights clearly using markdown cells.
- Avoid hardcoding paths. Use relative paths when working with files or data.
- Make sure that you have no credentials, paths or hardcoded password when submitting a new example.
- Fork the repository.
- Create a new branch for your feat/fix/chore/docs:
git checkout -b chore/my-awesome-notebook
- Commit your changes - ensure that you follow the below naming and convention:
git add . git commit -m "{chore/fix/feat}: Add new tutorial for synthetic time series data"
- Push to your fork:
git push origin chore/my-awesome-notebook
- Open a pull request from your branch to
main.
Please include:
- A brief description of your changes
- A screenshot or summary of outputs (when applicable)
- Mention of any related issues
We follow the Contributor Covenant to foster an inclusive and respectful environment. Please be kind and constructive in all interactions.
Thank you for making ydata-sdk and the community better! 🚀