Fix accuracy gaps in create.md bootstrap prompt for external agents - #50049
Conversation
…eference and Troubleshooting Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot always point to the main branch |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
PR Triage: #50049
Draft, doc-only fix (12+/6-) to create.md bootstrap prompt. CI is clean. Low risk, batch with other docs/chore PRs.
|
There was a problem hiding this comment.
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
mainbranch 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
| 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` |
|
|
||
| - 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` |
| - 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. |
|
🎉 This pull request is included in a new release. Release: |
create.mdis fetched directly via raw URL by external coding agents (Claude Code, Copilot, etc.) with no localgh-awcheckout, 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
https://github.com/github/gh-aw/v0.35.1/main(wrong domain, extra path segment) instead ofhttps://raw.githubusercontent.com/github/gh-aw/v0.35.1.[designer.md](designer.md)) resolve againstROOT/.github/aw/, since there's no local checkout to resolve them against otherwise.Command guidance
gh aw new <workflow-name>: it only scaffolds a bare template and is never used by the guidedcreate-agentic-workflow.mdinterview flow in Step 2, which writes and compiles the workflow file directly. The note now steers agents toward the guided path.gh aw compile --watchtip for iterative development while authoring/editing a workflow.Troubleshooting
debug-agentic-workflow.md) and the troubleshooting docs.No source code or compiled workflow files were touched; this is a documentation-only change.