Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (55 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 2.03 KB

Contributing to HashPrep

First off – thank you for considering contributing to HashPrep 💜
Your contributions help make this platform more useful for the ML community!

How to Contribute

Pull requests are welcome! For major changes, please open an issue first to discuss what you’d like to change. For new contributors, we suggest starting with Easy tasks.

Setup Instructions

Fork and clone the repository

git clone https://github.com/cachevector/hashprep.git
cd hashprep

Create a virtual environment

uv venv
source .venv/bin/activate

Install in development mode

uv sync --extra dev

Pull Request Guidelines

Don’t worry if you don’t get everything right – we’ll gladly help out.

PR Titles

Follow Conventional Commits:

feat: → New feature
fix: → Bug fix
docs: → Documentation changes
style: → Formatting, whitespace, non-functional
refactor: → Code change without new feature/bug fix
perf: → Performance improvement
test: → Adding/correcting tests
build: → Build system or dependency changes
ci: → CI/CD configuration
chore: → Maintenance tasks
revert: → Reverts a previous commit

Example: feat: add outlier detection module

PR Content

  • Keep PRs small and focused.
  • Use clear titles (example: feat: add CLI command for dataset profiling).
  • Add a short description of why you’re making the change.
  • If possible, add tests or examples to help us review faster.

Good to Know

  • It’s fine if you’re new to open source, we’re happy to help you through the process.
  • Documentation, bug reports, and testing are just as valuable as code!
  • The roadmap is evolving, if you have ideas, bring them up in issues/discussions.

Happy debugging!