Skip to content

docs(examples): rename issue resolver shared helper and remove grandf… - #274

Open
rishugudigar wants to merge 2 commits into
ARPAHLS:mainfrom
rishugudigar:dev_tools/issue_resolver
Open

docs(examples): rename issue resolver shared helper and remove grandf…#274
rishugudigar wants to merge 2 commits into
ARPAHLS:mainfrom
rishugudigar:dev_tools/issue_resolver

Conversation

@rishugudigar

@rishugudigar rishugudigar commented Aug 1, 2026

Copy link
Copy Markdown

…athered parity exception

Description

his PR cleans up the dev_tools/issue_resolver example/docs pairing by standardizing the shared GitHub-fetch helper under examples/issue_resolver_common.py and updating the provider examples to use it consistently. It also aligns the docs and registry expectations so the helper is treated as a support module rather than a runnable example, which keeps the example inventory and documentation story in sync.
Fixes #233

Type of Change

  • New Skill — new registry bundle under skills/
  • Skill Upgrade — changes to an existing skill under skills/
  • Bug Fix — incorrect runtime or framework behavior
  • Documentation — docs, README, CONTRIBUTING only
  • Framework Featureskillware/core/ loader, env, adapters
  • CLIskillware/cli.py, docs/usage/cli.md
  • Examplesexamples/*.py, agent loops, examples/README.md
  • Packaging — PyPI wheel, pyproject.toml, MANIFEST.in
  • RFC / meta — templates, labels, CI, or large design doc

Checklist (all PRs)

  • Linked GitHub issue (Fixes #… or Refs #…)
  • Scope matches the issue — no unrelated refactors
  • python -m black --check . and flake8 pass locally (or CI-equivalent subset)
  • pytest skills/ and pytest tests/ pass locally when relevant
  • CHANGELOG.md updated under [Unreleased] when user-visible behavior changes
  • examples/README.md updated if this PR adds, renames, or removes a runnable script
  • Ran pytest tests/test_registry_docs.py when skills, examples index, or agent-loops matrix changed

New or updated skill

Skip unless this PR adds or changes files under skills/.

Bundle and metadata

  • Skill at skills/<category>/<skill_name>/ (from templates/python_skill/ or equivalent)
  • manifest.yaml: name (full ID), version, description, parameters, constitution, real issuer
  • Optional: short_description, issuer.github, issuer.org, requirements, env_vars

Logic, cognition, tests

  • Deterministic skill.py (no ad-hoc LLM-generated execution paths)
  • instructions.md explains when and how to use the skill
  • card.json issuer matches manifest when present
  • test_skill.py covers execution and schema expectations
  • SkillLoader.load_skill("<category>/<skill_name>") succeeds (or deps documented)

Documentation and catalog

  • docs/skills/<skill_name>.md and row in docs/skills/README.md
  • Usage Examples for Gemini, Claude, OpenAI, DeepSeek, Ollama per skill usage template

Constitution and safety (skills only)

Related Issues

@rishugudigar
rishugudigar force-pushed the dev_tools/issue_resolver branch from 84d7502 to d29f2b3 Compare August 1, 2026 08:22
@rosspeili

Copy link
Copy Markdown
Contributor

Thanks @rishugudigar, this matches the scope nicely.

Before re-requesting review:

  • Changelog has a conflict, should be easy fix with rebase
  • Fill in the PR description (2–3 sentences on what changed and why), looks cut to me at start
  • Tick Examples in the type checklist since examples/*.py changed

Once these are clean, this is good to merge <3

@rishugudigar

Copy link
Copy Markdown
Author

the conflict is resolved, check ticked and added the PR description

@rosspeili

Copy link
Copy Markdown
Contributor

Thanks for the updates @rishugudigar, the rename, imports, test cleanup, and issue_resolver.md note all match 233 scope.

Not merge-ready yet: CHANGELOG.md on your branch still contains a ======= conflict marker (~line 43). Please rebase onto current main, remove that marker, and add a single Changed line under the existing [Unreleased] (don’t duplicate old unreleased blocks). Tick Examples in the PR type checklist since examples/*.py changed., but most imporatntly I still see a cut "…athered parity exception" at the start of pr. Both are minor cleanups but keep the pr and audit trail clean.

Once that’s clean and CI is green, good to merge. <3

@rosspeili

Copy link
Copy Markdown
Contributor

Thanks @rishugudigar, the rename is on the right track, but the branch is not merge-ready yet. Please address all of the below in one update in this branch (no follow-up PRs).

Required before merge

  1. Rebase onto current main
    The branch is far behind (Aug). Rebase cleanly, do not merge stale history. After rebase, resolve any CHANGELOG.md conflicts and place your entry under today’s [Unreleased]Changed (do not duplicate old unreleased blocks).

  2. tests/test_examples_smoke.py
    Rename the skip entry: issue_resolver_github_context.pyissue_resolver_common.py in LIVE_PROVIDER_SCRIPTS.
    Without this, test_every_example_script_has_smoke_or_skip_classification fails in CI.

  3. docs/skills/issue_resolver.md

  4. CHANGELOG.md
    One line under [Unreleased]Changed, e.g. rename helper to issue_resolver_common.py, remove grandfather hack, docs note, Fixes #233.

  5. PR description
    Rewrite cleanly (full sentences, not a cut title): what changed, why, files touched, Fixes #233. Tick Examples in the type checklist and complete the PR template checklist honestly.

  6. Verify locally after rebase

    python -m black --check .
    python -m flake8 .
    pytest tests/test_registry_docs.py tests/test_examples_smoke.py
    pytest tests/

Already good (keep)

  • Rename + import updates in the three *_issue_resolver.py scripts
  • Remove GRANDFATHERED_EXAMPLES from tests/test_registry_docs.py
  • No new row in examples/README.md for the helper

Once rebase + smoke test + skill history + CHANGELOG + description are clean and CI is green, good to merge. Thanks!

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