Get Involved¶
Future Development
As the RuleFlow Software expands, we may develop and introduce more detailed policies and instructions for contribution and development.
We welcome contributions ranging from bug fixes and new FlowLang directives to custom RuleFlow Studio plugins and documentation improvements. Whether you are a systems engineer, a complex systems researcher, or a hobbyist, there is a place for your expertise.
Core Community Guidelines¶
Before contributing, please review our core community guidelines:
- Contribution Guidelines: Policies on contributing to the project, architectural boundaries, and testing requirements.
- Code of Conduct: Our standards for maintaining a collaborative environment.
- AI Usage Policy: Guidelines regarding the acceptable use, verification, and disclosure of AI-assisted code and documentation.
Ways to Contribute¶
You do not need to be an expert in the core engine to make an impact. Here are a few ways you can help expand the RuleFlow ecosystem:
- Code & Architecture: Optimize memory topologies, add robust tests for vector slicing, or expand the FlowLang parser grammar.
- RuleFlow Studio Plugins: Build custom UI tools, visualizers, or data exporters for the terminal IDE.
- Research & Configurations: Submit verified
.flowrule examples, benchmark scripts, or multiway system configurations. - Discussions & Bug Reports: Open issues to report unexpected behavior, suggest new engine flags (e.g., stochastic thresholds or conflict resolution protocols), or discuss architectural improvements before building. Our official discussions channel is hosted on GitHub Discussions.
Open Source Resources¶
If you are new to open-source software or want to learn more about standard community workflows, these resources are excellent starting points:
- Open Source Guides: How to Contribute: GitHub's comprehensive breakdown of how to find issues, submit pull requests, and communicate effectively with maintainers.
- How to Write a Git Commit Message: Industry standards for writing clean, imperative commit messages that keep project histories readable.
- The MIT License Explained: A plain-English overview of RuleFlow's open-source license and how to manage third-party dependencies compliantly.