Contributing
Conduit is developed against a live production network, which shapes how changes land.
The bar#
- Verified, not just built. Panel changes are proven in the browser against the running system; connector changes against live server logs; infra changes on the actual nodes. A change without its verification story isn't done.
- Code is the source of truth. If docs and implementation disagree, one of them changes in the same commit.
- Design system compliance. Panel surfaces follow the established Cloudflare-style system — flat panels, hairlines, the shared motion primitives, no shadows or glow. See docs/development.md.
Practicalities#
- Setup: docs/install.md → Development.
CONDUIT_CONTROLLER=offkeeps the reconcile loop away from your cluster while you work on UI/API. - Checks:
npx tsc --noEmitandnpm run buildmust pass; the connector must build withbash plugin/build.sh. - Commits: plain human prose,
area: what changedsubjects, no co-author trailers. - Comments: same voice as the commits — explain why, no shouted emphasis or
NOTE:labels. See docs/development.md → Conventions. - Branching: work lands on
masterdirectly; no pull-request workflow.
Scope guidance#
Bug reports with reproduction steps are always welcome. For features, open an issue first — the roadmap is driven by the production network's needs, and discussing the design up front avoids wasted work. Contributions are accepted under the project's AGPL-3.0 license (inbound = outbound).