microsoft / microsoft/qdk

Add infrastructure for validating stand-alone Python files in samples

Open
#1,859 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement samples
Dominant language
Rust
Stars
1k
Forks
212
Avg merge
3d 8h
Merged PRs (30d)
65

Description

Right now, new Q# projects added to samples get automatically picked up and compiled in CI, along with stand-alone Q# in certain folders. CI also runs most notebooks to confirm cells execute without error. But for samples like those added #1858 that include a stand-alone Python file nothing in CI runs the code to confirm we aren't breaking the Python scripts. We should have something that runs these files in CI so we don't accidentally introduce breaking changes for them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing CI checks that compile Q# projects and standalone Q# files, and that execute notebooks. Add validation for standalone Python files in samples, with completion shown by CI running those files and reporting failures when they break.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.