chore: housekeeping — examples pin, doc fixes, import cleanup#24
Merged
Conversation
Wraps up the remaining low-risk tidy-ups from TECHNICAL-REVIEW plus a docs review. - §7.1: bump examples/*.yml action pin @v0.3 -> @v0.7 (the long-stale pin; docs/user/* already use v0.7). 2 files. - §8.9: hoist the 4 lazy `from . import __version__` calls in github_handler.py to a single module-top import. No circular import to avoid; module imports cleanly. - CONTRIBUTING.md: the root file was a stale duplicate with broken instructions (`pip install -r requirements.txt` and `python -m style_checker.main --mode single` — neither exists after the uv migration / action.py rename). Replaced with a concise, correct quick-start that defers to the canonical docs/developer/contributing.md. - .github/copilot-instructions.md: version example 0.6.1 -> 0.7.2; `pytest` -> `uv run pytest`; stale `v0.3` release-tag example -> a `vX.Y` placeholder consistent with the surrounding `vX.Y.Z` steps. - CHANGELOG: note the examples pin bump under [Unreleased]. Tests: 87 passed; ruff clean; example workflows still parse. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Housekeeping pass to align docs and examples with the current v0.7.x release line and remove redundant lazy imports in the GitHub Action handler, without intended behavior changes in the checker itself.
Changes:
- Hoist
__version__import to module scope instyle_checker/github_handler.py(removing repeated per-method imports). - Update example workflows to use
QuantEcon/action-style-guide@v0.7instead of the stale@v0.3. - Refresh contributor and Copilot guidance docs to match the current uv-based workflow; note the examples pin bump in
CHANGELOG.md.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| style_checker/github_handler.py | Hoists __version__ import to module scope to avoid repeated lazy imports. |
| examples/style-guide-weekly.yml | Pins example workflow to @v0.7. |
| examples/style-guide-comment.yml | Pins example workflow to @v0.7 (but still needs an id fix for outputs usage). |
| CONTRIBUTING.md | Replaces stale setup/testing instructions with a uv + qestyle/pytest quick start that defers to canonical docs. |
| CHANGELOG.md | Notes the example workflow pin bump under Unreleased. |
| .github/copilot-instructions.md | Updates version/test/release snippets to match current 0.7.2 and uv run pytest. |
The "Run style guide checker" step lacked `id: run-checker`, but a later step references `steps.run-checker.outputs.pr-url`. Without the id that reference resolves to an empty string, so the success message with the PR link never fired (the workflow always posted "no PR created"). Adds `id: run-checker` to match the existing reference, mirroring the working style-guide-weekly.yml example. Addresses Copilot review feedback on #24. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
Summary
A single housekeeping pass wrapping up the remaining low-risk tidy-ups from
TECHNICAL-REVIEW.mdplus a docs review. No behavior changes; +52 / −184 across 6 files.What changed
Code
github_handler.pydidfrom . import __version__inside four separate methods. Moved to a single module-top import (there's no circular import to avoid). Module imports cleanly;__version__still resolves to0.7.2.Examples (user-facing)
examples/style-guide-comment.ymlandexamples/style-guide-weekly.ymlfrom the long-stale@v0.3to@v0.7, matching thedocs/user/*snippets (which were already onv0.7).Docs review
CONTRIBUTING.md. It was a stale duplicate of the canonicaldocs/developer/contributing.mdwith broken instructions —pip install -r requirements.txt(file removed in the uv migration) and a "Testing Locally" section invokingpython -m style_checker.main --mode single(a module that doesn't exist; predates theaction.pyrename and theqestyleCLI). Replaced with a concise, correct quick-start (uv +qestyle/pytest) that defers to the canonical developer guide, so the two can't drift again..github/copilot-instructions.md— fixed three stale spots: the__version__example0.6.1 → 0.7.2; the release-process test commandpytest → uv run pytest; and the stale literalv0.3floating-tag example → avX.Yplaceholder consistent with the surroundingvX.Y.Zsteps.[Unreleased].Deliberately left alone
action.py --mode single …in copilot-instructions is valid (action.py really has that argparse CLI) — not touched.CHANGELOG.md,PLAN.md,TECHNICAL-REVIEW.md,roadmap.md, and theprompts/v0.6.1/archive are accurate records — left as-is.Test plan
uv run pytest tests/→ 87 passedruff checkclean🤖 Generated with Claude Code