tensorflow/quantum

Avoid hard-coding "quantum" in `scripts/` scripts

Open

#1,082 opened on Jun 5, 2026

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (653 forks)github user discovery
area/devopshelp wantedno QC knowledge neededpriority/before-0.7.7

Repository metrics

Stars
 (2,145 stars)
PR merge metrics
 (PR metrics pending)

Description

scripts/ci_validate_tutorials.sh has a hard-coded assumption that the user's local git working directory is named "quantum":

cd ..
examples_output=$(python3 quantum/scripts/test_tutorials.py)

This fails for developers who (like me) have multiple copies of the TFQ source tree, with different names for different concurrent development projects. Instead of assuming the directory is quantum, the scripts in the scripts/ directory should get the correct name using code such as the following:

thisdir=$(CDPATH="" cd -- "$(dirname -- "${0}")" && pwd -P)
repo_dir=$(git -C "${thisdir}" rev-parse --show-toplevel 2>/dev/null)

Contributor guide

Research direction
Review scripts/ci validate tutorials.sh to locate the hard coded directory name. Use git rev parse and dirname to dynamically obtain the repo root. Test your changes by running the script from a differently named clone.
Tech stack
shellpython
Domain
ci cd
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitShell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95