Ciaren

Open source, AGPL-3.0

Help build Ciaren

Every node, connector, and doc page is public work. Whether you file one bug or maintain a plugin, this is where the project happens.

Your first PR in four steps

  1. 1

    Fork and clone

    Fork ciaren-labs/Ciaren on GitHub, then clone your fork.

  2. 2

    Set up

    pip install -e ".[dev]" in backend, npm install in frontend.

  3. 3

    Change and test

    Branch from main, keep the change focused, and run pytest.

  4. 4

    Open a PR to main

    Push to your fork and open the PR. No sign-off or CLA needed.

Where the project lives

  • GitHub

    Code, releases, and the issue tracker.

  • Discussions

    Ask questions, propose features, and share what you're building.

  • Contributing

    How to set up a dev environment, open issues, and land your first PR.

  • Good first issues

    Curated, well-scoped issues labelled for new contributors.

  • Security policy

    How to report vulnerabilities privately instead of in public issues.

  • Plugin development

    Build nodes, connectors, and ML model types with the Apache-2.0 plugin SDK.

Contributing

Ways to contribute besides code

Use it and report back

Run Ciaren on a real dataset and file what breaks or confuses you. This early on, a precise bug report is worth as much as a patch.

Improve the docs

Recipes, screenshots, and clearer explanations help every future user. Docs PRs are the friendliest entry point to the codebase.

Build a plugin

Write a connector for your data source or a node for your use case. Plugins extend Ciaren without changes to the core.

Shape the roadmap

The direction is decided in the open. Weigh in on discussions, vote on proposals, and make the case for what you need.

Make a first contribution

Pick a good first issue, or tell us what you're trying to build.