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.
- Fork & Branch: Create a feature branch targeting the next patch iteration (
feat/vX.Y.Z). - Code Quality & Complexity Ceilings:
- Zero
unsafeblocks (#![forbid(unsafe_code)]). - Cyclomatic complexity
<= 10per function; cognitive complexity<= 15per function. - Maximum
60lines of code per function and500lines per file.
- Zero
- SPDX Headers: Every source file must carry
SPDX-FileCopyrightTextandSPDX-License-Identifier: Apache-2.0 OR MITheaders.
2. Running Local Quality Gates
Core Rust Library (nucleusflow)
Documentation Website (nucleusflow.github.io)
# Compile with ssg 0.0.69 and run all lint, test, and WCAG AAA audit suites
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 MITlicense.