Contribution Guide¶

This guide provides information on how to contribute to the aiFlows. Whether you’re interested in coding, documentation, collaboration, fixing bugs or adding features you’ll find useful resources here. If you know what you’re looking for, use the table of contents to jump right in. If you’re new to aiFlows, start with the Preface section below.

Table of Contents¶

Preface¶

Our goal is to make Flows a community-driven project that will benefit researchers and developers alike (see the Why should I use aiFlows? ) and to achieve this goal, we need your help.

You can become a part of the project in a few ways:

contribute to the aiFlows codebase: this will directly improve the library and benefit everyone using it

contribute to the FlowVerse: by making your work accessible to everyone, others might improve your work and build on it, or you can build on others’ work

use the library in your creative projects, push it to its limits, and share your feedback: the proof of the pudding is in the eating, and the best way to identify promising directions, as well as important missing features, is by experimenting

last but not least, star the repository and shout out aiFlows with your friends and colleagues; spread the word with love

We will support the community in the best way we can but also lead by example. In the coming weeks, we will share:

a roadmap for the library (FlowViz; FlowStudio; improve flexibility, developer experience, and support for concurrency, etc. – feedback and help would be greatly appreciated!)

write-ups outlining features, ideas, and our long-term vision for Flows – we encourage you to pick up any of these and start working on them in whatever way you see fit

a version of JARVIS – your fully customizable open-source version of ChatGPT+(++), which we will continue building in public! We hope that this excites you as much as it excites us, and JARVIS will become one of those useful projects that will constantly push the boundaries of what’s possible with Flows

We have tried to find a way for anyone to benefit by contributing to the project. Below we describe the envisioned workflows in more detail (we would love to hear your feedback on this – the Discord server already has a channel for it :)).

In a nutshell, this is just the beginning, and we have a long way to go. Stay tuned, and let’s work on a great (open-source) AI future together!

Want To Contribute to aiFlows?¶

Connecting With Like-Minded Contributors & How To Get Help ?¶

Explore the Looking for Collaborators ? section for resources, tips, and guidance on connecting with potential collaborators, sharing project ideas, building your dream team or how to get help. 🚀🌟

Contributing To aiFlows Library: Bug Fixes and Feature Additions Guide¶

Contribute to the aiFlows Library! Follow the guidelines in the Contributing to aiFlows Library (for bug fixes and adding features) guide for bug fixes and feature additions. Report issues on GitHub, discuss on Discord, and create pull requests. Your contributions matter! 🚀🌟

Contributing To the FlowVerse: Creating New Flows and Contributing To Existing Flows Guide¶

Contribute to the Flows from the FlowVerse! Follow the guidelines in the Recommended Workflow for Contributing to a Flow on the FlowVerse guide to understand how to create and publish your Flow or contribute to an existing one. 🚀

Automating the Generation of FlowCards (README) for the FlowVerse¶

Check out the Automating the documentation of a Flow on the FlowVerse guide to speed up the process of creating FlowCards (READMEs) for the FlowVerse.

Coding Standards for aiFlows¶

Review the coding standards for aiFlows Library contributions in the Coding Standards guide. Essential guidelines ensuring a high-quality codebase. Familiarize yourself with these standards before submitting your Pull Request. 🚀⭐

Licence Information (Spoiler Alert: It’s Open-Source and Completely Free!)¶

Check out Licence Info: Frequently Asked Questions to get quick answers about aiFlows’ open-source MIT License, its free-of-charge accessibility, and you can use in commercial projects. Explore how you can contribute to the thriving aiFlows community without any worries about the legal stuff. 🚀🌟