simpleflo

Documentation

Community

Contributing, support channels, and community norms.

Community

Conduit is open for community collaboration, whether you just want it to work today or you want to extend it safely. If you are a practitioner, your bug reports and real-world workflows shape the product. If you are a builder, your PRs and design discussions help keep Conduit reliable and local-first. We aim for a respectful, rigorous tone and we welcome contributors who follow the guide and stay focused. Start with the main repo and issues tracker, and use the templates to keep things crisp.

Image

conduit-community-circuits | alt: A friendly diagram of Conduit's ecosystem: users <-> issues <-> PRs <-> docs <-> releases, with guardrails like security and test coverage.

Where to start

  1. I found a bug
  1. I have a feature idea
  1. I want to contribute code/docs

What Conduit is focusing on right now

Current priorities, based on the PRD and HLDs:

  • Private KB for AI tools via MCP, local-first and zero cloud by default.
  • Retrieval quality: hybrid search, citations, and repeatable workflows.
  • Multi-client integration with a stable CLI surface.
  • Operational reliability: clear diagnostics, predictable behavior, and local isolation.

Not in scope yet (see PRD for the roadmap):

  • Connector marketplace and third-party MCP server management.
  • Remote client support and secure link/tunneling.
  • Enterprise RBAC and organization-level policies.

Notes on maturity:

  • CLI is the stable source of truth.
  • The desktop GUI is experimental and not feature-complete.
  • The connector hub vision is staged for later releases.

References:

How to file a great issue

Use the bug report template and include:

  • What you expected vs what happened.
  • Minimal reproduction steps.
  • OS + Conduit version (run conduit --version).
  • Container runtime version (Podman or Docker) and DBs if relevant.
  • Output from conduit doctor.
  • Logs if relevant (the bug template suggests ~/.conduit/daemon.log).

Privacy note: do not paste secrets. Redact tokens, private repo URLs, or sensitive file paths before posting.

How to propose a feature (without writing a novel)

Start with the feature request template, which asks for:

  • Problem statement
  • Proposed solution
  • CLI interface sketch (if applicable)
  • Expected behavior
  • Alternatives considered
  • Use case

If you want to go deeper, add:

  • Who it helps
  • Why now
  • Risks (security, complexity, compatibility)
  • Acceptance criteria

Conduit prefers additions that reduce setup friction and preserve user control.

Contribution guide (practical)

Follow CONTRIBUTING for the full details. Highlights from the current guide:

  • Prereqs: Go 1.21+, Git, Podman or Docker (tests), Node 18+ for desktop app work.
  • Build and test:
    • make build
    • make test
    • make lint
  • Conventional commits for PR titles.
  • Update docs when behavior changes.

If you are new, start with docs or a small bugfix. Larger changes should start with an issue.

What makes a PR likely to merge

  • Small and focused change with clear scope.
  • Improves reliability, security, or clarity.
  • Updates docs when user-facing behavior changes.
  • Tests included or at least a test plan in the PR.
  • Matches the conventional commit format in PR title.

Docs contributions (high leverage)

Docs are a first-class surface. The best docs PRs:

  • explain the "why" behind behavior
  • reduce setup friction
  • add examples and failure-mode guidance

Useful links:

Security and responsible disclosure

There is no dedicated SECURITY.md in the repo today. If a report is sensitive, open an issue asking for a private channel before sharing details. Consider adding a SECURITY.md as a small, high-impact improvement.

A small community roadmap

  • Today: private KB via MCP with a CLI-first workflow.
  • Next: polish, stability, better diagnostics, and safer secrets handling.
  • Later: the connector marketplace and broader MCP ecosystem support.

If you are a user, your bug reports shape the product. If you are a contributor, we will help you land your first PR.