docs: standalone-script note for the project_board import bootstrap#66
Merged
Conversation
Hit twice this session while writing quick live smoke tests outside pytest (exercising coder_seam.test_rung() against a real repo + a real delegate, bypassing the need for a full plugin host) -- reached for a manual symlink workaround before realizing tests/conftest.py already solves this properly (registers the repo root under sys.modules["project_board"] via importlib.util.spec_from_file_location, no symlink/rename needed). Document the actual mechanism in the README so the next standalone script doesn't rediscover the workaround. Snippet verified to actually run standalone (not just copied from conftest.py). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
👀 Quinn is reviewing — verdict (PASS / WARN / FAIL) + findings to follow. |
![protoquinn[bot]](https://avatars.githubusercontent.com/in/3282126?s=60&v=4){kind=small}
There was a problem hiding this comment.
QA Audit — PR #66 | docs: standalone-script note for the project_board import bootstrap
VERDICT: WARN (non-blocking; CI still queued — will re-review when terminal)
CI Status
- test: ⏳ queued
Diff Review
- README.md only — adds a "Standalone scripts (outside pytest)" section (+26 lines).
- Documents the
importlib.utilbootstrap thattests/conftest.pyalready uses, with a copy-paste-ready snippet for one-off smoke tests. - Clear, accurate, and the author verified the snippet runs standalone.
Observations
- No findings. Docs-only, well-scoped, no unresolved threads. A clean docs improvement.
— Quinn, QA Engineer
|
Submitted COMMENT review on #66. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Hit twice this session writing quick live smoke tests outside pytest (e.g. exercising
coder_seam.test_rung()against a real repo + a real delegate, without standing up a whole plugin host) — reached for a manual symlink workaround (ln -sfn projectBoard-plugin project_board) before realizingtests/conftest.pyalready solves this properly:No symlink, no rename needed — this registers the repo root's
__init__.pyundersys.modules["project_board"]directly. It only fires insideconftest.py, so a barepython script.py(notpytest) never sees it.What
Documents the actual mechanism in a new "Standalone scripts" README section — the snippet is copy-paste-ready and verified to actually run standalone (not just copied from conftest.py and assumed correct).
Docs-only. Gate:
ruff check . && ruff format --check . && pytest -q— 269 passed (unaffected).🤖 Generated with Claude Code