Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.34 KB
Raw

Contributing

Development setup

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt

Model files are downloaded locally and should not be committed to the repository. The default cache root is ~/.cache/imgtagplus, with a repo-local fallback at .cache/imgtagplus when the home cache is unavailable. The repository ignores .cache/ so those downloads stay local.

If you want to pre-download the CLIP model during setup, run:

python -m imgtagplus -i ./test_image.jpg --model-id clip --silent --output-dir /tmp/imgtagplus-model-warmup

If you also develop against Florence, repeat that command with --model-id florence-2-base.

If you change frontend styles, also run:

npm install
npm run build:css

Validation

Run the local checks before opening a PR:

ruff check .
pytest

Scope

  • Prefer small, reviewable pull requests.
  • Keep sandbox and local-only safety behavior intact unless a change intentionally revises the spec.
  • Add tests for behavior changes, especially around metadata writing, server validation, and model-selection logic.

Pull requests

  • Describe the user-visible impact.
  • Note any dependency or model-cache changes.
  • Update README.md, SPEC.md, or CHANGELOG.md when behavior or developer workflow changes.