mirror of https://github.com/superdesigndev/treg.git synced 2026-10-02 03:24:35 +08:00

Files

T

SToneX aa6c150591 ci(tests): run the Postgres job in parallel, one database per worker

Under TREG_TEST_DB_URL each xdist worker now creates and uses its own
database, so the Postgres job no longer has to run serially. Without it,
every sqlite test process gets its own pid-named file, removed at exit,
so two runs in one checkout no longer wipe each other's tables.

Also move test_orgs_isolation.py and test_orgs_mgmt.py into the Postgres
test list: they had landed inside the failure-diagnostics psql script and
never ran on Postgres.

2026-09-25 21:17:25 +08:00

3.3 KiB

Raw Blame History

Contributing to tools-registry

Thanks for your interest!

Getting set up

git clone https://github.com/superdesigndev/treg
cd treg
bash scripts/build-dashboard.sh # Node 22.12+ and npm; compile the browser app
uv sync                     # install deps (uv >= 0.12, pinned in pyproject - https://docs.astral.sh/uv/)
uv run --with pytest-xdist pytest -n auto -q   # daily local default (same shape as CI)

No .env needed for dev — every setting has a working default (ephemeral encryption key, local sqlite). The TREG_* knobs for persistence / a real deployment are documented in the README's Configuration section (and docs/context/ops/deploy.md).

A one-command local stack is in scripts/dev-local.sh (up / logs / cli / reset). It starts Python on :18790 and Vite on :5173; open http://localhost:18790/app. TREG_DEV_DB=/absolute/path/to/dev.db selects a separate local database without resetting another.

The Dashboard source is in frontend/src/: .vue pages, components and dialogs, feature use cases in state/, and a typed JSON client in api.ts. frontend/index.html is only the document entry. Run npm --prefix frontend test for transport tests and npm --prefix frontend run test:e2e for browser flows against a disposable SQLite server. Install Chromium first with cd frontend && npx playwright install chromium.

Before uv build, run bash scripts/build-dashboard.sh. The wheel and sdist include the resulting assets; installing a published package needs no Node runtime. Editable Python installs do not require a frontend build, so CLI and background-worker development remains independent.

Project layout

src/treg/ — the app (FastAPI API, proxy, CLI, runners). The design docs in docs/context/ explain each subsystem and cite the source files they cover — read the relevant fragment before changing code.
tests/ — the test suite (pytest). New behavior needs a test.
docs/context/ — per-subsystem design fragments (the source of truth for "how it works").

Making a change

Branch off main.
Match the surrounding style — plain Python with type hints, no new dependencies without a reason. Commit messages follow Conventional Commits (feat(scope): …, fix: …, docs: …).
Add or update tests; run uv run --with pytest-xdist pytest -n auto -q (all green). Serial uv run --frozen python -m pytest -q is for debugging one test or order. Against Postgres, set TREG_TEST_DB_URL; each xdist worker creates its own database from it.
If you changed a subsystem, update its fragment in docs/context/ in the same PR.
Open a PR. CI runs the tests + a secret scan; a maintainer reviews.

What to work on

The roadmap lives at the end of README.md (MCP support, finer permission tiers, key-management hardening). Bug reports and small fixes are welcome anytime; for a larger feature, open an issue first so we can agree on the approach before you invest in it.

Reporting bugs / security issues

Normal bugs → a GitHub issue. Security vulnerabilities → see SECURITY.md (report privately, never in a public issue).

Code of conduct

Be kind and constructive. Harassment or personal attacks are not tolerated; maintainers may remove comments or contributors that cross that line.

3.3 KiB Raw Blame History