From 30528235a59a8fec9de99d84778c67711ff05fb0 Mon Sep 17 00:00:00 2001 From: Aidan Feldman Date: Wed, 14 Jan 2026 21:09:08 -0500 Subject: [PATCH] chore: explain how to set up for local development --- CONTRIBUTING.md | 7 +++++++ Makefile | 3 +++ 2 files changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e0c29b3e..08787d4ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,13 @@ YData-profiling aims to ease exploratory data analysis for structured datasets, Our focus is to provide users with useful and robust statistics for such datasets encountered in industry, academia and elsewhere. YData-profiling is open-source and stimulates contributions from passionate community users. +#### Setup + +```sh +python -m venv .venv +make install-dev +make test +`` #### Themes to contribute In line with our aim, we identify the following themes: diff --git a/Makefile b/Makefile index 22a69c758..ac1af7ef2 100644 --- a/Makefile +++ b/Makefile @@ -41,6 +41,9 @@ install-spark-ci: --output ${SPARK_DIRECTORY}/spark.tgz cd ${SPARK_DIRECTORY} && tar -xvzf spark.tgz && mv spark-${SPARK_VERSION}-bin-hadoop${HADOOP_VERSION} spark +install-dev: + pip install -e ".[dev,test]" + publish-docs: examples ### Publishes the documentation mkdir docs/examples rsync -R examples/*/*.html docs