docs: add hidden agent prompt to README for agentic workflow setup#44679
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
July 10, 2026 07:20
View session
pelikhan
approved these changes
Jul 10, 2026
pelikhan
marked this pull request as ready for review
July 10, 2026 07:31
Contributor
🤖 PR Triage
Score breakdown: impact 8 + urgency 6 + quality 8 Rationale: README-only change adding a collapsed agent-readable block. No code or config touched. Safe to auto-merge.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an agent-facing setup prompt near the top of README.md using a collapsed <details> block, intended to make agentic workflow setup discoverable to automated agents scanning raw markdown.
Changes:
- Adds a new
<details>section with step-by-step instructions to installgh aw, rungh aw init, and scaffold a daily repo status workflow viagh aw add --create-pull-request. - Introduces a visible README entry point (“Configure this project with agentic workflows”) intended to guide agents toward repo setup.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds a collapsed agent setup prompt with installation, initialization, and workflow scaffolding instructions. |
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: Low
| --> | ||
|
|
||
| <details> | ||
| <summary>Configure this project with agentic workflows</summary> |
Comment on lines
+20
to
+22
| ```bash | ||
| curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash | ||
| ``` |
Comment on lines
+24
to
+34
| 2. Run the `init` command to configure the repository: | ||
|
|
||
| ```bash | ||
| gh aw init | ||
| ``` | ||
|
|
||
| 3. Add a **daily repo status** agentic workflow using the `add` command: | ||
|
|
||
| ```bash | ||
| gh aw add --create-pull-request | ||
| ``` |
Contributor
|
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Agents scanning
README.mdhave no discoverable entry point for setting up agentic workflows in a repo. This adds a collapsed<details>block near the top of the README — invisible to humans by default, but fully visible to agents reading raw markdown.Changes
README.md— adds a<details>section with a self-contained agent prompt that:gh awviainstall-gh-aw.sh(no GitHub token required)gh aw initto configure the repogh aw add --create-pull-requestto scaffold a daily repo status workflow (copilot engine,copilot-requests: write)