OspreyFlowOpen-source project

Contribute

Help build OspreyFlow

Code is one way to contribute. A connector for a source you know, a domain model for your field, a clearer page in a guide or a well-described bug are all as welcome.

Open the repository

Where to start

Try it and tell us

Install Lite with a starter, work through a demonstration case, and open an issue for anything that confused you or broke.

Connectors and pipelines

A connector reads one kind of source; a pipeline maps it to a domain model. Each is a small, self-contained file with its own test.

Domain models

Crime, anti-money laundering, fraud and cyber ship today. A model for another field is a contribution in itself.

Guides

The guides live in the repository as Markdown. Corrections and clearer wording are reviewed like code.

Adapters

Each of the four ports has a conformance suite. An adapter for another engine is supported once it passes it.

Accessibility

The screens are scanned automatically in the light and dark themes. Reports from people using assistive technology are especially valuable.

What we ask of a change

  • Synthetic data only. No real person's data in a test, a fixture, a screenshot or an issue.
  • A test that fails first. A fix arrives with a test that fails without it.
  • Access control is never weakened. A read that skips the viewer's access is refused at review.
  • Plain words on screen. A refusal says what was refused and why, in words a person can act on.
  • You have the right to submit it. Contributions are made under the Apache License 2.0.

How a change is reviewed

  1. Open an issue describing the problem, or comment on an existing one.
  2. Open a pull request.
  3. A maintainer reviews it. A change to access control or to what may leave a deployment gets a second reviewer.
  4. Once merged, it ships in the next release and is named in the change log.

The repository's contributing guide and code of conduct are not yet in the repository. Until then, open an issue to start a conversation.

Security

Please do not open a public issue for a security problem. Report it privately to servicecentre@solirius.com. Put 'OspreyFlow security' in the subject.

Want help to run it? Solirius Reply offers pilots, builds and support: ospreyflow.net.