Contributing to RasQberry

We welcome contributions to this quantum computing education project!

How to Contribute

1. Test & Report Issues

The most valuable contribution is testing and reporting bugs:

  • Try out RasQberry on your hardware
  • Report issues with clear steps to reproduce
  • Include error messages, screenshots, and hardware details
  • Paste the output of rq_info.sh --json: RasQberry version, build origin, A/B slot and Pi model

2. Share Ideas & Feature Requests

Have ideas for improvements?

  • Open a GitHub Discussion or issue
  • Suggest new demos, UX improvements, or educational features

3. Improve Documentation

Help make RasQberry easier to use:

  • Fix typos or unclear instructions
  • Add troubleshooting tips
  • Use the "Edit this page" link at the bottom of any page

4. Create Quantum Demos

Build new interactive demonstrations:

  1. Create your demo using Python and Qiskit, in its own GitHub repository with requirements.txt and README.md
  2. Add an rqb-demo.json manifest at the repository root that says how the demo runs (python, jupyter, browser or docker); the format is described in EXTERNAL_DEMOS.md
  3. Open a pull request that adds your repository, pinned to a commit, to RQB2-config/known-demos.json
  4. Once merged, users install it from Quantum Demos → Manage demos → Add demo from catalogue (rq_demo_add_external.sh <id>)

Example demos for inspiration:

Quick Links

ResourceLink
Report IssuesGitHub Issues
DiscussionsGitHub Discussions
Existing DemosDemo List
Project RepositoryRasQberry-Two

Resources

Learning Qiskit:

Development:

  • Python 3.11+, Raspberry Pi 4 or 5
  • RasQberry OS image from releases
Edit this page on GitHub