Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 760 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 760 Bytes

Contributing

Setup

python3 -m pip install -e .[dev]

Test

Run the unit test suite before opening a pull request:

python3 -m pytest -q
python3 -m build

Live API Checks

Live generation tests are optional and require Higgsfield credentials:

export HF_KEY="your-key:your-secret"

Or use split credentials:

export HF_API_KEY="your-key"
export HF_API_SECRET="your-secret"

Then run:

python3 examples/simple_generate.py

Pull Requests

  • Keep changes focused.
  • Add or update tests when behavior changes.
  • Update docs when the public API or workflow changes.
  • Do not commit generated assets, local credentials, or cache files.
  • Prefer small, reviewable diffs over broad refactors.