NEBULA-DEVELOPMENT(1)
Nebula Manual
NAMEdevelopment — Guidelines for developing Nebula.
SOURCEnebula/CONTRIBUTING.md
STATUSpre-alpha · protocol in design
01
Development setup
Clone and build the workspace.
output
git clone https://github.com/zeitlos/nebula.git
cd nebula
cargo build --workspace02
Quality checks
Run these checks before submitting changes.
output
cargo fmt --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
cargo deny check
cargo audit03
Production validation
Test production-path configurations before releasing.
output
NEBULA_TEST_PROFILE=fast ./tests/production/validate-production.sh04
Code style
Nebula follows standard Rust conventions.
- →Prefer simple, explicit Rust
- →Keep security-sensitive logic fail-closed
- →Avoid broad authorization shortcuts
- →Split large modules when review becomes difficult
05
What to submit
Contributions are welcome for scoped changes with tests. Open an issue for large design changes before starting work.
- →Narrowly scoped changes
- →Tests for behavior changes
- →Documentation updates for CLI/API changes
- →No secrets, private data, or generated artifacts