Skip to content

Write down how Qunova takes doc changes from the fork to IBM - #7

Merged
seihyun-jeong merged 1 commit into
mainfrom
docs/qunova-process
Oct 7, 2026
Merged

seihyun-jeong merged 1 commit into
mainfrom
docs/qunova-process

Conversation

@seihyun-jeong

Copy link
Copy Markdown
Collaborator

Summary

Adds QUNOVA.md at the root of our fork's main. It records how we now take doc changes from this fork to IBM, so everyone (and Claude Code) follows the same steps.

  • Branches: our main is the fork hub and is never the head of an IBM PR. upstream-main is a locked copy of IBM's main, used as the base of review PRs. Each change gets a branch cut from IBM's main. pr-screenshots holds the review images.
  • Eight steps: branch, Changelog, checks, screenshots, review PR, approval, same branch to IBM, sync after merge. [Review before IBM] HI-VQE docs for the 4.0.0 function #6 is the worked example.
  • Rules: supalert-qunova is a required reviewer. Changelog format: plain bullets per version, newest first.
  • Repository settings: why the two preview workflows are disabled, and the upstream-main ruleset with the commands to refresh it.
  • Local preview on Apple Silicon.
  • Status: 4.0.0 is in review in [Review before IBM] HI-VQE docs for the 4.0.0 function #6. Document usage-based billing and the 5.0.x function #3 (5.0.x) still has to be moved onto the new flow.

Also adds qunova/screenshots.py, the before/after capture used for #6, with qunova/shots/hivqe-4.0.0.json as an example input.

Everything here is fork-only. Because change branches are cut from IBM's main, none of it reaches IBM. The fork is public, so the document only covers procedure.

Test plan

🤖 Generated with Claude Code

Until now the process lived in chat threads. Upstream PRs were opened
from the fork's main, which now carries fork-only changes such as the
./start fix, and the repository settings we changed were noted nowhere.

QUNOVA.md covers:
- the branches (upstream-main, change branches, pr-screenshots)
- the eight steps from a branch cut from IBM's main to the IBM PR
- the required reviewer and the Changelog rules
- the repository settings: the disabled preview workflows and the
  upstream-main ruleset, with how to refresh it
- running the preview on Apple Silicon
- where 4.0.0 and 5.0.x stand

qunova/screenshots.py is the before/after capture used for #6. It used
to be a throwaway script; it now takes a shots file, and
qunova/shots/hivqe-4.0.0.json is the one #6 used.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@seihyun-jeong
seihyun-jeong requested review from supalert-qunova and removed request for supalert-qunova October 7, 2026 02:11
@seihyun-jeong
seihyun-jeong merged commit 27bdc64 into main Oct 7, 2026
3 checks passed
@seihyun-jeong
seihyun-jeong deleted the docs/qunova-process branch October 7, 2026 02:27
seihyun-jeong added a commit that referenced this pull request Oct 7, 2026
npm run check:fmt flagged the tables in QUNOVA.md, which had been
failing since #7.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
seihyun-jeong added a commit that referenced this pull request Oct 13, 2026
Brings this branch up to date with main (#7 to #11 and the IBM sync), so
the PR no longer shows QUNOVA.md and qunova/ as deleted.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant