Skip to main content

Project governance & contribution

Welcome to the fluxrig institutional engineering hub. This section defines the governance model, contribution workflows, and licensing boundaries for the project. Our goal is to maintain a high-performance, open-core ecosystem where architectural integrity, operational safety, and Technical Autonomy are never compromised.

To start contributing, follow the standard build and test cycle:

# Clone & Setup
git clone https://github.com/jaab-tech/fluxrig.git
cd fluxrig

# Build Toolchain (Binaries + Catalog)
make build

# Add to PATH (Optional but Recommended)
export PATH=$PATH:$(pwd)/bin

Local validation loop​

Before submitting a Pull Request, verify your changes using the institutional validation loop:

make lint       # Security & Style check
make test       # Core Logic check
make test-robot # Protocol Integrity check
make regression # System E2E check

The developer journey​

Navigating a high-performance orchestration platform requires a clear roadmap. We maintain an institutional four-stage process from induction to production.

Phase: Architectural induction​

Start by aligning your local workstation with the Environment & layout guide. You will need a "Dual Head" setup (Mixer + Rack) to verify logic end-to-end.

Phase: Implementation​

Follow the Developing specialized gears tutorial. Ensure all new code adheres to the Engineering standards, focusing on context propagation, error wrapping, and structured logging.

Phase: Verification​

We maintain a "Hard Engineering" posture. Every contribution is a reflection of the system's overall reliability and is not complete until it passes our high-fidelity verification layers:

  • Unit & Integration: make test (Minimum 60% coverage).
  • Protocol Integrity: make test-robot (Real-world signal validation via Robot Framework).
  • System Regression: make regression (Full E2E parity).

Governance & integrity​

Developer Certificate of Origin (DCO)​

To protect the open-source integrity and maintain clear licensing boundaries, fluxrig requires a DCO 1.1 sign-off on every commit. This is a legally binding statement that you have the right to submit the code.

AI code hygiene (Human accountability protocol)​

We embrace AI-assisted engineering but maintain absolute human accountability. AI-generated code is treated as a third-party dependency:

  1. Deterministic Validation: Every AI-assisted contribution must be functionally validated via the full institutional test suite.
  2. Architectural Curation: The human author must ensure AI-generated blocks adhere to the project's Engineering standards and naming conventions (Mixer, Rack, Gear).
  3. Institutional Accountability: The human engineer signing the DCO sign-off takes full responsibility for the code's performance, security, and long-term maintainability.

IMPORTANT

We view AI as a high-performance augmentation tool, but the Human Architect remains the final arbiter of the system's high-fidelity state.

Dependency hygiene​

We maintain strict compliance to ensure no "License Contamination":

  • Permissive Linkage: Only libraries with Apache 2.0, MIT, or BSD-style licenses are permitted.
  • AGPL Boundaries: External services (e.g., Grafana) are accessed solely via network protocols. Never link against AGPL code.

Licensing & commercial strategy​

fluxrig operates under a Loose Open Core model.

  • Foundation (Apache 2.0): The core engine (fluxrig, Rack, Mixer) and standard protocol Gears are open source and free forever.
  • Commercial (Enterprise): We monetize "Day 2" operational tools (Visual UI, RBAC, Audit Logs), custom engineering, and long-term OLAP analytics.

Community engagement​

  • Discord: Real-time architectural collaboration.
  • GitHub Issues: Official institutional tracking.
  • Code of Conduct: Decision making is based strictly on technical merit and benchmarked reality.