Skip to content

docs: explain how to get Hunk skill#414

Open
zzl0 wants to merge 1 commit into
modem-dev:mainfrom
zzl0:doc
Open

docs: explain how to get Hunk skill#414
zzl0 wants to merge 1 commit into
modem-dev:mainfrom
zzl0:doc

Conversation

@zzl0

@zzl0 zzl0 commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

The README copy-paste prompt should tell agents how to find the bundled Hunk review skill, not just ask them to load it. This keeps the quick-start agent workflow self-contained and matches the fuller agent workflow guide.

It also matches the prompt in agent-workflows.md: https://github.com/modem-dev/hunk/blob/main/docs/agent-workflows.md?plain=1#L17

Summary:
The README copy-paste prompt should tell agents how to find the bundled Hunk review skill, not just ask them to load it. This keeps the quick-start agent workflow self-contained and matches the fuller agent workflow guide.
@zzl0 zzl0 marked this pull request as ready for review June 10, 2026 20:19
@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates the quick-start agent prompt in README.md to include the command that tells an agent how to find the bundled Hunk skill, making the workflow self-contained without needing to refer to external documentation.

  • The prompt in the README's "Working with agents" section now includes Run \hunk skill path` to get the skill path., bringing it into exact alignment with the same prompt already present in docs/agent-workflows.md` (line 17).
  • No functional or behavioral changes; this is a documentation-only update.

Confidence Score: 5/5

Documentation-only change with no functional impact; safe to merge.

A single sentence is added to a copy-paste prompt in the README, making it match the identical prompt already present in docs/agent-workflows.md. The change is accurate — hunk skill path is already documented in the preceding step on line 83 — and introduces no ambiguity or inconsistency.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds Run \hunk skill path` to get the skill path.` to the agent quick-start prompt, making it self-contained and matching the identical prompt in docs/agent-workflows.md.

Sequence Diagram

sequenceDiagram
    participant User
    participant Agent
    participant HunkCLI as hunk CLI

    User->>Agent: "Load the Hunk skill and use it for this review. Run `hunk skill path` to get the skill path."
    Agent->>HunkCLI: hunk skill path
    HunkCLI-->>Agent: /path/to/skills/hunk-review/SKILL.md
    Agent->>Agent: Load skill from returned path
    Agent->>HunkCLI: Use skill to review live Hunk session
Loading

Reviews (1): Last reviewed commit: "docs: explain how to get Hunk skill" | Re-trigger Greptile

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.

1 participant