Open Source

Contributing to NucleusFlow

Engineering standards, verification gates, and pull request discipline.

1. Development Workflow

We welcome contributions to both the core Rust repository and the documentation portal.

  1. Fork & Branch: Create a feature branch targeting the next patch iteration (feat/vX.Y.Z).
  2. Code Quality & Complexity Ceilings:
    • Zero unsafe blocks (#![forbid(unsafe_code)]).
    • Cyclomatic complexity <= 10 per function; cognitive complexity <= 15 per function.
    • Maximum 60 lines of code per function and 500 lines per file.
  3. SPDX Headers: Every source file must carry SPDX-FileCopyrightText and SPDX-License-Identifier: Apache-2.0 OR MIT headers.

2. Running Local Quality Gates

Core Rust Library (nucleusflow)

cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-targets --all-features

Documentation Website (nucleusflow.github.io)

# Compile with ssg 0.0.69 and run all lint, test, and WCAG AAA audit suites
make verify

3. Commit & Pull Request Conventions

  • Conventional Commits: <type>: <subject> (maximum 50 characters, imperative mood; body wrapped at 72 characters).
  • Signed Commits: Sign commits with SSH/GPG (git commit -S -s).
  • Dual Licensing: All contributions are provided under the repository's dual Apache-2.0 OR MIT license.