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

Files

T

Jason ZhouandClaude Fable 5 4eccbfdd37 chore: repo renamed to superdesigndev/treg — update all self-references

GitHub redirects the old slug, but every URL we publish (pyproject,
npm package, plugin manifest, issue templates, web pages, llms.txt)
now says the real name. PyPI package name stays tools-registry.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

2026-08-11 20:54:30 +10:00

2.1 KiB

Raw Blame History

Contributing to tools-registry

Thanks for your interest!

Getting set up

git clone https://github.com/superdesigndev/treg
cd treg
uv sync                     # install deps (uv — https://docs.astral.sh/uv/)
uv run pytest -q            # the full suite should pass before you start

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).

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 pytest -q (all green).
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.

2.1 KiB Raw Blame History