Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
105 lines (74 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

105 lines (74 loc) · 3.27 KB

Contributing to QONTOS

We welcome contributions to QONTOS. This guide applies to all repositories under the qontos organization.

Getting Started

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Run the test suite
  5. Submit a pull request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME

# Create virtual environment
python -m venv .venv
source .venv/bin/activate

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Run linter
ruff check src/

# Run type checker
mypy src/

Code Standards

  • Style: We use Ruff for linting and formatting. Run ruff check and ruff format before committing.
  • Types: All public APIs must have type annotations. We use mypy for type checking.
  • Tests: All new features and bug fixes must include tests. We use pytest.
  • Docstrings: Public functions and classes must have docstrings (Google style).

Pull Request Process

  1. Ensure CI passes (lint, typecheck, test, build).
  2. Update documentation if you changed public APIs.
  3. Add a CHANGELOG entry for user-facing changes.
  4. Request review from a maintainer.
  5. Squash commits before merge (or we will squash on merge).

Commit Messages

Use conventional commit format:

feat: add spectral partitioning for large circuits
fix: correct qubit mapping in tensor product aggregation
docs: update scheduling API reference
test: add coverage for noisy simulation edge cases

Reporting Issues

Public Release Policy

QONTOS uses pinned Git tags for pre-release distribution until packages are published to PyPI.

Current policy

Rule Value
Install method git+https://github.com/qontos/<repo>.git@<tag>
SDK current tag v0.2.0
Simulator current tag v0.1.0
Security contact [email protected]
Enterprise support [email protected]

On each public release

  1. Tag the SDK repo (qontos) with the new version
  2. Update qontos-sim/pyproject.toml dependency to the new SDK tag
  3. Tag the sim repo (qontos-sim)
  4. Update qontos-examples/requirements.txt to both new tags
  5. Update all README install snippets across repos
  6. Run bash .github/scripts/check-doc-consistency.sh to verify

Rules for public-facing docs

  • Never write pip install qontos or pip install qontos-sim as current-state guidance until packages are on PyPI
  • Never use @main in install instructions — always pin to a release tag
  • Use [email protected] for all vulnerability reporting references
  • Mark future-state instructions clearly with "> Note: Once published to PyPI..."

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to abide by its terms.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.