Contributing to Dift

Thanks for your interest in contributing to Dift.

We welcome thoughtful contributions that improve the project for real users.

Our Goal

Dift is an open-source tool for comparing datasets and building trust in data changes.

We value contributions that improve usability, reliability, performance, documentation clarity, test coverage, and developer experience.

Before opening a Pull Request, make sure your branch is up-to-date with the latest version of main.

This helps prevent merge conflicts and ensures your changes work with the current codebase.

git checkout main
git pull upstream main

git checkout your-branch
git rebase upstream/main

If you forked the repository, add the original repo as upstream:

git remote add upstream https://github.com/ReginaldErzoah/Dift.git

Pull requests that are significantly behind main may be requested to update before review.

python -m venv .venv
source .venv/Scripts/activate
pip install -r requirements.txt
pip install -e .
pytest
ruff check .

The following pull requests may be closed without merge:

Please explain:

Meaningful contributions help make Dift the standard open-source dataset diff tool.