Developer's Guide to Contribution

Master our development workflow, tools, and best practices to make impactful contributions.

Start Building

Getting Started

1

Clone Our Projects

Use our centralized GitHub organization to access all repositories. Most projects require Node.js 18+, Python 3.10+, and Rust 1.60+.

git clone https://github.com/opensource/quantumsim.git
cd quantumsim
npm install
pnpm install
2

Code with Confidence

Our projects use TypeScript, Python, and Rust with standardized code formatting (Prettier, Black, and rustfmt).

TypeScript
Python
Rust
3

Run Tests

All projects use automated testing workflows with GitHub Actions. Make sure your code passes all existing tests.

Pipeline Status: Passing ✅

Code Quality Standards

Linter Configuration

All code must pass our linter (TypeScript ESLint, Pylint, and Rust Clippy). Configuration is available in each project's root.

ESLint Pylint Clippy

Code Review Process

All contributions require at least one approval from a project maintainer. Make sure to request a review after addressing all feedback.

Approval Time

Average 72 hours

Project-Specific Guidelines

QuantumSim

Develop with Q# and C# for quantum simulation. Requires Microsoft Quantum Development Kit.

Q# C#
View QuantumSim Docs →

CloudOS

Use Rust and WebAssembly for core components. Requires Cargo and Wasmtime.

Rust Wasm
View CloudOS Docs →

AI Framework

Contribute to Python TensorFlow models. Requires Jupyter and PyTorch integration.

Python TensorFlow
View AI Framework Docs →

Community Guidelines

✓

Welcome

All developers are welcome to contribute regardless of experience level. Ask questions on Discord!

2

Code of Conduct

Our contributor covenant promotes mutual respect. Read our Code of Conduct before participating.

∞

Long-term

We value sustainability over speed. Take time with your contributions to ensure quality.