Skip to content

examples(issue_resolver): rename shared helper to issue_resolver_common and remove GRANDFATHERED_EXAMPLES - #358

Merged
rosspeili merged 4 commits into
ARPAHLS:mainfrom
mashood-memon:examples/issue-233-rename-issue-resolver-helper
Oct 12, 2026
Merged

rosspeili merged 4 commits into
ARPAHLS:mainfrom
mashood-memon:examples/issue-233-rename-issue-resolver-helper

Conversation

@mashood-memon

Copy link
Copy Markdown
Contributor

Closes #233

What changed

  • Renamed examples/issue_resolver_github_context.py → examples/issue_resolver_common.py to match the *_common.py helper module convention
  • Updated import in examples/claude_issue_resolver.py, examples/gemini_issue_resolver.py, and examples/ollama_issue_resolver.py
  • Removed GRANDFATHERED_EXAMPLES set and TODO comment from tests/test_registry_docs.py — the existing *_common.py filter already excludes helpers
  • Updated skip entry in tests/test_examples_smoke.py to reference the new filename
  • Added ### Changed entry to CHANGELOG.md under [Unreleased]

Verification

  • pytest tests/test_registry_docs.py — 9 passed
  • pytest tests/test_examples_smoke.py — same 5 pre-existing failures (missing optional packages: google, trafilatura, rembg, python-pptx, pillow), no new failures introduced

Notes

  • examples/README.md, docs/usage/agent_loops.md, and docs/skills/issue_resolver.md do not reference issue_resolver_github_context.py — no changes needed there

@rosspeili

Copy link
Copy Markdown
Contributor

Thanks @mashood-memon, this is the cleanest take on #233 so far.

Before merge, please add a one-line note on docs/skills/issue_resolver.md that the three *_issue_resolver.py scripts share examples/issue_resolver_common.py, plus a docs-only Skill history row (same bar as #274 review). No manifest bump needed.

Once that’s in and CI is green, good to merge, and I will change the assignee on the issue <3

@mashood-memon
mashood-memon force-pushed the examples/issue-233-rename-issue-resolver-helper branch from 15bbf7a to 341d437 Compare September 17, 2026 18:59
@rosspeili

Copy link
Copy Markdown
Contributor

Hey @mashood-memon, thanks for addressing the earlier review comments!

The core rename and test cleanups look great, but the branch currently has merge conflicts against main and needs two quick path adjustments before we can merge:

  1. Rebase onto current main: Resolve conflicts in CHANGELOG.md (move entry under current ## [Unreleased]) and tests/test_examples_smoke.py.
  2. Catalog Page Relocated: The issue resolver catalog page was moved to docs/skills/dev_tools/issue_resolver.md as part of the category-based docs reorg ([Docs]: Structured Hub Architecture for catalog SEO, category indexing, and deep GitHub search discovery #370). Please ensure your note and Skill history row are applied to docs/skills/dev_tools/issue_resolver.md (rather than recreating the old docs/skills/issue_resolver.md).
  3. Relative Link Depth: In docs/skills/dev_tools/issue_resolver.md, update the link to three parent hops: ../../../examples/issue_resolver_common.py.

Once rebased and CI is green, we will merge this and close #233 and #274. Thank you!

@mashood-memon
mashood-memon force-pushed the examples/issue-233-rename-issue-resolver-helper branch from 341d437 to 317afb9 Compare October 11, 2026 17:42
@mashood-memon

Copy link
Copy Markdown
Contributor Author

Thanks for the pointers! I have rebased onto current main, moved the changelog entry under ## [Unreleased], updated the catalog page path at docs/skills/dev_tools/issue_resolver.md, and adjusted the helper link depth to ../../../examples/issue_resolver_common.py. All local doc-drift and smoke checks are passing.

@rosspeili rosspeili left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the review comments and updating the link depth as needed. LGTM. Will merge and resolve the changelog conflict on merge. Closes #233 and supersedes #274.

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.

[Examples]: Rename issue_resolver_github_context.py to issue_resolver_common.py

2 participants