Adding your project

Use this guide to contribute a solution or project to the qBraid Explore page. qBraid reviews the project and prepares its environment so users can run it in Lab.

To browse projects, events, and challenges, or submit a project through Account, see Explore catalog.

Step 1: Create a public GitHub repository

Create a public GitHub repository containing your project. You can include example notebooks, executable Python files, or code in other languages, such as C++ or Julia.

Include a README that describes the project and explains how to use it. Review existing Explore projects for examples, or ask your qBraid contact for guidance.

qBraid reviews your README and provides feedback. If it does not clearly describe the project, or includes setup instructions that do not apply to qBraid, we may ask for a separate Markdown file with qBraid-specific instructions. We can link the listing to that file so users see it when they open the project.

Step 2: Send us environment and project details

Send all the details below in one email to contact@qbraid.com or your qBraid point of contact. We use these details to create the environment and prepare the project listing.

Environment details

• Send the minimal package dependencies needed to run your code and examples, such as a requirements.txt or the relevant dependencies from pyproject.toml. Do not send a full pip list.
• Include square logos in both light and dark versions. qBraid uses them for the environment sidebar image and kernel logo.
• State any non-Python runtime or GPU requirements. We can arrange a custom Docker container or GPU resources and confirm the requirements with you.

Project details

• Include a one- or two-sentence description for Explore.
• Provide tags that help users find the project.
• Include the public GitHub repository URL from Step 1.

If you have already submitted the project through Add your project in Account, mention that request in the email so we can match it to the environment details. The in-app form does not replace the environment requirements above.

Step 3: What happens next

1. qBraid creates the environment and shares it with your qBraid account.
2. Find it under Shared environments in Lab and test your code and examples.
3. Tell your qBraid contact about any changes you need.
4. Once you are satisfied with the environment, qBraid adds the project to Explore.
5. Review the published listing and request any final changes.

Questions?

Contact contact@qbraid.com or your qBraid point of contact.