Skip to content

Fix accuracy gaps in create.md bootstrap prompt for external agents - #50049

Merged
pelikhan merged 3 commits into
mainfrom
copilot/review-create-md-optimizations
Aug 3, 2026
Merged

Fix accuracy gaps in create.md bootstrap prompt for external agents#50049
pelikhan merged 3 commits into
mainfrom
copilot/review-create-md-optimizations

Conversation

Copilot AI commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

create.md is fetched directly via raw URL by external coding agents (Claude Code, Copilot, etc.) with no local gh-aw checkout, so it must be self-contained and unambiguous. It contained a broken URL example and several gaps that could misdirect an agent bootstrapping purely from the fetched file.

URL resolution

  • Fixed the versioned-tag ROOT example, which pointed to https://github.com/github/gh-aw/v0.35.1/main (wrong domain, extra path segment) instead of https://raw.githubusercontent.com/github/gh-aw/v0.35.1.
  • Made explicit that agents must fetch (HTTP GET) prompt files rather than just "follow" them.
  • Clarified that relative links inside loaded prompt files (e.g. [designer.md](designer.md)) resolve against ROOT/.github/aw/, since there's no local checkout to resolve them against otherwise.

Command guidance

  • Corrected the Quick Reference entry for gh aw new <workflow-name>: it only scaffolds a bare template and is never used by the guided create-agentic-workflow.md interview flow in Step 2, which writes and compiles the workflow file directly. The note now steers agents toward the guided path.
  • Added a gh aw compile --watch tip for iterative development while authoring/editing a workflow.

Troubleshooting

  • Replaced the vague, linkless "Troubleshooting" section with concrete pointers to the debug prompt (debug-agentic-workflow.md) and the troubleshooting docs.

No source code or compiled workflow files were touched; this is a documentation-only change.

…eference and Troubleshooting

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title Improve accuracy and clarity of create.md bootstrap prompt Fix accuracy gaps in create.md bootstrap prompt for external agents Aug 3, 2026
Copilot AI requested a review from pelikhan August 3, 2026 17:12
@pelikhan

pelikhan commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

@copilot always point to the main branch

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

@copilot always point to the main branch

Fixed in b852de0 — ROOT now always resolves to the main branch (https://raw.githubusercontent.com/github/gh-aw/main), regardless of the tag/branch the file was fetched from.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

PR Triage: #50049

  • Category: docs
  • Risk: low
  • Score: 41/100 (Impact 15 + Urgency 8 + Quality 18)
  • Recommended action: batch_review
  • Batch: pr-batch:docs-chore

Draft, doc-only fix (12+/6-) to create.md bootstrap prompt. CI is clean. Low risk, batch with other docs/chore PRs.

Generated by 🔧 PR Triage Agent · auto · 51.1 AIC · ⌖ 4.08 AIC · ⊞ 8K ·

@pelikhan
pelikhan marked this pull request as ready for review August 3, 2026 19:17
Copilot AI review requested due to automatic review settings August 3, 2026 19:17
@pelikhan
pelikhan merged commit ffd5b1a into main Aug 3, 2026
@pelikhan
pelikhan deleted the copilot/review-create-md-optimizations branch August 3, 2026 19:17
Copilot stopped reviewing on behalf of pelikhan due to an error August 3, 2026 19:17

Copilot AI 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.

Pull request overview

Note

Copilot could not run the full agentic suite for this review because it was automatically requested on a bot-authored pull request. Request a review from Copilot under Reviewers to retry with the full agentic suite. Improved support for bot-authored pull requests is coming soon.

Updates create.md to make the “Step 2” prompt-loading process more explicit and to improve troubleshooting guidance by pointing to specific repository files (and a fixed main-branch ROOT).

Changes:

  • Clarifies that users should fetch (download) the full prompt file content and read it before acting.
  • Replaces variable ROOT examples with a fixed ROOT on the main branch and adds instructions for resolving relative links in prompt files.
  • Expands troubleshooting and quick reference notes with more specific pointers.
Show a summary per file
File Description
create.md Tightens instructions for loading prompt files (fixed ROOT, relative link resolution) and adds targeted troubleshooting pointers.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 3
  • Review effort level: Lite

Comment thread create.md
Comment on lines +43 to +45
Below, ROOT is the location where you found this file. Always use the main branch, regardless of the URL you fetched this file from:

- if this file is at `https://raw.githubusercontent.com/github/gh-aw/main/create.md` then the ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`
- if this file is at `https://raw.githubusercontent.com/github/gh-aw/v0.35.1/create.md` then the ROOT is `https://github.com/github/gh-aw/v0.35.1/main`
- ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`
Comment thread create.md

- if this file is at `https://raw.githubusercontent.com/github/gh-aw/main/create.md` then the ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`
- if this file is at `https://raw.githubusercontent.com/github/gh-aw/v0.35.1/create.md` then the ROOT is `https://github.com/github/gh-aw/v0.35.1/main`
- ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`
Comment thread create.md
- if this file is at `https://raw.githubusercontent.com/github/gh-aw/v0.35.1/create.md` then the ROOT is `https://github.com/github/gh-aw/v0.35.1/main`
- ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`

Prompt files under `ROOT/.github/aw/` may reference other files in that same directory using relative links (e.g. `[designer.md](designer.md)`). Resolve those links against `ROOT/.github/aw/` as well, and fetch and read them before proceeding if they are relevant to the task.
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.84.4

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants