Skip to content

chore: explain how to set up for local development #1803

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.

Sign up for GitHub

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

Open
afeld wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

chore: explain how to set up for local development #1803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down