chore: add long-running AI agent playbook scaffolding#7
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds universal long-running agent playbook scaffolding to standardize how agents track objectives, progress, and final outcomes, while appending an overlay to existing agent instruction files.
Changes:
- Added long-running session templates:
PRD.md,PROGRESS.md,GOAL_RESULT.md. - Appended a “Universal Long-Running Agent Overlay” section to
AGENTS.md,CLAUDE.md, and.github/copilot-instructions.md.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
PRD.md |
New PRD template intended to be the source of truth for long-running sessions. |
PROGRESS.md |
New progress/checkpoint log template for persistent tracking across checkpoints. |
GOAL_RESULT.md |
New final report template capturing changes, validation, risks, and suggested PR content. |
AGENTS.md |
Appends the universal overlay describing how to use PRD/PROGRESS/GOAL_RESULT in long-running sessions. |
CLAUDE.md |
Appends the same universal overlay for Claude-specific agent guidance. |
.github/copilot-instructions.md |
Appends the same universal overlay for GitHub Copilot instruction guidance. |
Comment on lines
+220
to
+230
| ## Universal Long-Running Agent Overlay | ||
|
|
||
| This section complements the repository-specific guidance already in this file. If anything here conflicts with the repo-specific rules above, the repo-specific rules win. | ||
|
|
||
| - `PRD.md` is the task source of truth for long-running sessions. | ||
| - `PROGRESS.md` is the persistent checkpoint log. | ||
| - `GOAL_RESULT.md` is the final execution report. | ||
| - Before coding, read this file, `PRD.md`, `PROGRESS.md` when it exists, `README.md`, project manifests, tests, and the relevant source folders. | ||
| - Work in small checkpoints, run the smallest relevant validation after each meaningful change, update `PROGRESS.md`, and continue until complete or genuinely blocked. | ||
| - Stop only when the requested work is complete, validation is documented, and `GOAL_RESULT.md` reflects the outcome. | ||
| - Do not rewrite unrelated architecture, fake successful validation, expose secrets, or push without explicit operator instruction for the active session. |
Comment on lines
+226
to
+236
| ## Universal Long-Running Agent Overlay | ||
|
|
||
| This section complements the repository-specific guidance already in this file. If anything here conflicts with the repo-specific rules above, the repo-specific rules win. | ||
|
|
||
| - `PRD.md` is the task source of truth for long-running sessions. | ||
| - `PROGRESS.md` is the persistent checkpoint log. | ||
| - `GOAL_RESULT.md` is the final execution report. | ||
| - Before coding, read this file, `PRD.md`, `PROGRESS.md` when it exists, `README.md`, project manifests, tests, and the relevant source folders. | ||
| - Work in small checkpoints, run the smallest relevant validation after each meaningful change, update `PROGRESS.md`, and continue until complete or genuinely blocked. | ||
| - Stop only when the requested work is complete, validation is documented, and `GOAL_RESULT.md` reflects the outcome. | ||
| - Do not rewrite unrelated architecture, fake successful validation, expose secrets, or push without explicit operator instruction for the active session. |
Comment on lines
+202
to
+212
| ## Universal Long-Running Agent Overlay | ||
|
|
||
| This section complements the repository-specific guidance already in this file. If anything here conflicts with the repo-specific rules above, the repo-specific rules win. | ||
|
|
||
| - `PRD.md` is the task source of truth for long-running sessions. | ||
| - `PROGRESS.md` is the persistent checkpoint log. | ||
| - `GOAL_RESULT.md` is the final execution report. | ||
| - Before coding, read this file, `PRD.md`, `PROGRESS.md` when it exists, `README.md`, project manifests, tests, and the relevant source folders. | ||
| - Work in small checkpoints, run the smallest relevant validation after each meaningful change, update `PROGRESS.md`, and continue until complete or genuinely blocked. | ||
| - Stop only when the requested work is complete, validation is documented, and `GOAL_RESULT.md` reflects the outcome. | ||
| - Do not rewrite unrelated architecture, fake successful validation, expose secrets, or push without explicit operator instruction for the active session. |
Comment on lines
+1
to
+6
| # PRD - Feature Name | ||
|
|
||
| ## Objective | ||
|
|
||
| Describe exactly what must be implemented. | ||
|
|
Comment on lines
+1
to
+27
| # Progress Log | ||
|
|
||
| ## Current Status | ||
|
|
||
| Not started. | ||
|
|
||
| ## Checkpoints | ||
|
|
||
| ### Checkpoint 1 | ||
|
|
||
| Status: pending | ||
|
|
||
| Task: | ||
|
|
||
| Result: | ||
|
|
||
| Validation: | ||
|
|
||
| Next: | ||
|
|
||
| ## Blockers | ||
|
|
||
| None. | ||
|
|
||
| ## Validation History | ||
|
|
||
| | Command | Result | Notes | |
Comment on lines
+1
to
+6
| # Goal Result | ||
|
|
||
| ## Summary | ||
|
|
||
| Describe what was completed. | ||
|
|
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.
Summary
taskflow run /var/folders/4w/3kxdvh6s4ts7rw5h21rk3xr40000gn/T/codex-playbook-pjsr6zwk/repo (ok)