Skip to content

🧑‍💻 Base Example Device on Template#326

Open
ystade wants to merge 34 commits intodevelopfrom
example-device-template
Open

🧑‍💻 Base Example Device on Template#326
ystade wants to merge 34 commits intodevelopfrom
example-device-template

Conversation

@ystade
Copy link
Collaborator

@ystade ystade commented Feb 11, 2026

Description

This PR refactors the example device implementation by instantiating the device template for the example device. This adds a couple of convieniet features to the example device like install instructin and the packaging as a python package.

Checklist:

  • The pull request only contains commits that are focused and relevant to this change.
  • I have added appropriate tests that cover the new/changed functionality.
  • I have updated the documentation to reflect these changes.
  • I have added entries to the changelog for any noteworthy additions, changes, fixes, or
    removals.
  • I have added migration instructions to the upgrade guide (if needed).
  • The changes follow the project's style guidelines and introduce no new warnings.
  • The changes are fully tested and pass the CI checks.
  • I have reviewed my own code changes.

@ystade ystade added this to the v1.3.0 milestone Feb 11, 2026
@ystade ystade self-assigned this Feb 11, 2026
@ystade ystade added enhancement Enhancement of existing functionality refactor Refactoring the code base usability Increasing usability of the library labels Feb 11, 2026
@ystade ystade changed the base branch from develop to install-all-header February 11, 2026 10:14
@codecov
Copy link

codecov bot commented Feb 11, 2026

Codecov Report

❌ Patch coverage is 0.88496% with 112 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
examples/device/test/test_cxx_device.cpp 0.0% 111 Missing ⚠️
examples/driver/qdmi_example_driver.cpp 50.0% 1 Missing ⚠️

❌ Your patch check has failed because the patch coverage (0.8%) is below the target coverage (90.0%). You can increase the patch coverage or adjust the target coverage.
❌ Your project check has failed because the head coverage (67.3%) is below the adjusted base coverage (89.7%). You can increase the head coverage or adjust the Removed Code Behavior.

Impacted file tree graph

@@            Coverage Diff             @@
##           develop    #326      +/-   ##
==========================================
- Coverage     90.3%   67.3%   -23.0%     
==========================================
  Files            6       6              
  Lines          732     496     -236     
  Branches       141      66      -75     
==========================================
- Hits           661     334     -327     
- Misses          71     162      +91     
Flag Coverage Δ
cpp 67.3% <0.8%> (-23.0%) ⬇️
Files with missing lines Coverage Δ
examples/driver/qdmi_example_driver.cpp 92.5% <50.0%> (-0.5%) ⬇️
examples/device/test/test_cxx_device.cpp 0.0% <0.0%> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://Munich-Quantum-Software-Stack.github.io/QDMI/pr-preview/pr-326/

Built to branch gh-pages at 2026-02-17 13:49 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@@ -1,5 +1,5 @@
ignore:
- "test/**/*"
- "/**/test/**/*"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously, codecov was complaining that all test files included in the examples/device/test/ directory are not covered. I am not sure whether this does actually the trick, because the output of codecov does not show at all anymore in the list of completed jobs.

@burgholzer burgholzer modified the milestones: v1.3.0, v1.2.3 Feb 15, 2026
Base automatically changed from install-all-header to develop February 15, 2026 15:27
@burgholzer
Copy link
Contributor

@ystade This can be rebased now that #325 is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Enhancement of existing functionality refactor Refactoring the code base usability Increasing usability of the library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants