Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (33 loc) · 978 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 978 Bytes

Contributing

Thanks for helping improve Snapshot.

Development

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

On Windows PowerShell:

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Checks

Run the full local check before opening a pull request:

python -m black --check .
python -m ruff check .
python -m mypy
python -m pytest
docker compose config --quiet

Pull Requests

  • Keep changes focused and explain the user-visible behavior.
  • Add or update tests for API behavior, security boundaries, and storage changes.
  • Do not commit secrets, generated uploads, logs, virtual environments, or caches.
  • Update documentation when configuration, deployment, or API behavior changes.

Security

Please do not open public issues for vulnerabilities. Follow SECURITY.md instead.