Contributing

Thanks for helping improve pSEO Engine.

Development setup

python3 -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
PYTHONPATH=pipeline pytest -q pipeline/tests

Do not commit credentials, .env files, generated drafts, analytics exports, screenshots, local databases, or client/customer data.
Keep examples synthetic or clearly public-domain/permissively reusable.
Prefer small pull requests with tests for changed behavior.
Preserve the review-gated publishing model; publishing adapters should not auto-send without explicit caller intent.
Do not add unauthorized paywall/login-wall circumvention, credential misuse, proxy rotation for circumventing blocks, or aggressive retry behavior after a site denies access. Camoufox challenge resolution is allowed only behind explicit config for operator-owned or authorized targets, with bounded attempts and challenge_unresolved stop behavior on timeout.

Run the test suite.
Run ruff check pipeline. Lint must pass (config is in pyproject.toml).
Run a secret scan or at least the documented grep in docs/OPEN_SOURCE_RELEASE_CHECKLIST.md.
Confirm git status --ignored --short does not show accidentally tracked runtime output.
Update README/docs if behavior or configuration changes.