Skip to content

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

Description

@rosspeili

Script path(s)

examples/issue_resolver_github_context.py, examples/claude_issue_resolver.py, examples/gemini_issue_resolver.py, examples/ollama_issue_resolver.py

Skill ID (if applicable)

dev_tools/issue_resolver

Provider / pattern

Multi-skill harness

What needs to change?

examples/issue_resolver_github_context.py is a shared helper module, not a runnable example script. It holds GitHub fetch helpers for the three *_issue_resolver.py agent-loop demos.

Because the filename does not follow the *_common.py convention, tests/test_registry_docs.py excludes it via a grandfather hack:

# TODO: script examples/issue_resolver_github_context.py is a shared helper module and
#       should be renamed to examples/issue_resolver_common.py (see #183).
GRANDFATHERED_EXAMPLES: set[str] = {"issue_resolver_github_context.py"}

That forces special-case logic in the examples index parity test and confuses contributors browsing examples/.

Requested change

  1. Rename examples/issue_resolver_github_context.py → examples/issue_resolver_common.py
  2. Update imports in:
    • examples/claude_issue_resolver.py
    • examples/gemini_issue_resolver.py
    • examples/ollama_issue_resolver.py
  3. Remove GRANDFATHERED_EXAMPLES and the TODO from tests/test_registry_docs.py (the existing *_common.py filter already excludes helpers)
  4. Confirm the file is not listed in examples/README.md Runnable Scripts table (helpers stay off the index)

Context: #183 added the doc-drift guards and introduced this grandfather entry; the rename was left as follow-up cleanup.

Acceptance criteria

  • File renamed; three consumer scripts import issue_resolver_common
  • GRANDFATHERED_EXAMPLES removed from tests/test_registry_docs.py
  • pytest tests/test_registry_docs.py passes
  • No row added to examples/README.md for the helper

Related updates needed

  • examples/README.md index row
  • docs/usage/agent_loops.md reference matrix
  • docs/skills/.md Usage Examples
  • CHANGELOG [Unreleased]

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

examplesRunnable scripts under examples/, agent loops, or examples index.good first issueGood for newcomers.

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions