Contributions Guide

SWIRL welcomes contributions to SWIRL Community. The sections below outline the major types of contributions and the expected level of effort.

SearchProviders / Connectors

New SearchProviders and Connectors are welcome, provided they can be tested without expense. These contributions suit new to intermediate developers and typically take 1 day to 1 week, depending on test-server setup time.

Potential candidates

• Notion (service)
• MarqoDB (vector DB)
• ChromaDB (vector DB)
• RaptorDB (vector DB)
• MySQL (relational DB)
• SQLAlchemy (relational DB package)

Processors

Useful processors are always welcome, including:

• Regex-based result modifications — configurable pattern replacements.
• Query transformations — lookup and replace from CSV or a database.
• Ontology/taxonomy-based query expansion.

These tasks generally take 1–2 weeks for an intermediate or advanced developer.

Testing & Documentation

SWIRL has an extensive automated testing system and detailed documentation. Contributions in these areas range from small updates to major improvements. Contact us for details.

Guidelines for Submissions

• Branch off develop with a descriptive branch name.
• Follow the Gitflow branching model and ensure all required changes are included in your PR.

For more, see GitHub's Contributing to a Project guide.