Spaces:

HarryDataScience
/

documind-ai

Running

App Files Files Community

documind-ai / CONTRIBUTING.md

HarryDataScience

Replace with new DocuMind AI (FastAPI + FAISS)

5959a78 8 days ago

preview code

Raw History Blame Contribute Delete

368 Bytes

# Contributing

Use Python 3.10-3.12 and a virtual environment: `pip install -r requirements-dev.txt`, then run
`ruff check .` and `pytest tests/ -v` before opening a PR. Keep API routes and response fields
backwards compatible unless a change is explicitly discussed. Add a test for every bug fix.
Never commit `.env`, uploaded PDFs, or generated vector-store files.

	# Contributing

	Use Python 3.10-3.12 and a virtual environment: `pip install -r requirements-dev.txt`, then run
	`ruff check .` and `pytest tests/ -v` before opening a PR. Keep API routes and response fields
	backwards compatible unless a change is explicitly discussed. Add a test for every bug fix.
	Never commit `.env`, uploaded PDFs, or generated vector-store files.