Elid

Contributing to Elid's Open Source

How to contribute code, documentation, and ideas to our quantum-powered productivity platform.

Anna Wong
Anna Wong
January 25, 2025
Collaborative Coding

Getting Started

  • Fork our GitHub repositories under elid-open-source organization
  • Create isolated feature branches following semantic versioning
  • Run ./tools/contrib/validate.sh before submitting

Code Standards

TypeScript/JavaScript

  • • Strict type checking enabled
  • • AirBNB coding style guide
  • • Linting with eslint (configured in root .eslintrc.yml)

Python

  • • Type hints with mypy
  • • PEP8 with 88 character limit
  • • Type annotations in all public interfaces

Contribution Workflow

  1. 1

    Fork

    Create your fork in GitHub

  2. 2

    Develop

    Implement feature in develop branch

  3. 3

    Test

    All contributions require test coverage

  4. 4

    Submit

    Create PR with WIP: prefix until ready

Development Tools

Dev Environment

Use nix-shell for consistent dev setup

Testing

Integration tests require quantum simulator

Documentation

Document all exposed APIs in docs/

Ready to Contribute?

Join 250+ contributors shaping the future of quantum-powered productivity tools.

View our GitHub Projects