docs(kanban): document handoff evidence metadata#19512
Closed
Fearvox wants to merge 1 commit into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documents a recommended (optional) metadata convention for kanban_complete(...) handoffs so evidence can be consumed consistently by humans and downstream automation without scraping prose.
Changes:
- Adds a “Recommended handoff evidence” section describing a suggested
metadatashape for engineering/review tasks. - Emphasizes the convention is optional (not a schema requirement) and discourages placing secrets/logs/tokens/transcripts in metadata.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "changed_files": ["path/to/file.py"], | ||
| "verification": ["pytest tests/hermes_cli/test_kanban_db.py -q"], | ||
| "dependencies": ["parent task id or external issue, if any"], | ||
| "blocked_reason": null, |
| Keep secrets, raw logs, tokens, OAuth material, and unrelated transcripts out of | ||
| `metadata`. Store pointers and summaries instead. If a task has no files or | ||
| tests, say so explicitly in `summary` and use `metadata` for the evidence that | ||
| does exist, such as source URLs, issue ids, or manual review steps. |
Comment on lines
+159
to
+169
| For engineering and review tasks, prefer this optional metadata shape: | ||
|
|
||
| ```json | ||
| { | ||
| "changed_files": ["path/to/file.py"], | ||
| "verification": ["pytest tests/hermes_cli/test_kanban_db.py -q"], | ||
| "dependencies": ["parent task id or external issue, if any"], | ||
| "blocked_reason": null, | ||
| "retry_notes": "what failed before, if this was a retry", | ||
| "residual_risk": ["what was not tested or still needs human review"] | ||
| } |
Contributor
Author
|
Follow-up plan, keeping this PR intentionally small:
The goal is to make Kanban handoffs easier for humans and downstream agents to review without changing runtime behavior in the docs PR. |
14 tasks
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.
What does this PR do?
Documents an optional
metadataconvention for Kanban worker handoffs so humans, downstream agents, and dashboards can read the same evidence packet without scraping prose.This is intentionally docs-only. The runtime already accepts structured
metadatathroughkanban_complete(summary=..., metadata={...}); this PR only describes a practical shape for engineering/review tasks.Related Issue
No issue yet; this is a docs-only clarification for existing Kanban behavior.
Type of Change
Changes Made
website/docs/user-guide/features/kanban.mdchanged_files,verification,dependencies,blocked_reason,retry_notes, andresidual_risk.Evidence Checked
kanban_completealready exposessummaryandmetadataas the structured completion handoff.How to Test
website/docs/user-guide/features/kanban.md.Not run: full website build. This is a docs-only copy change with no code/runtime path touched.
Checklist
Code
pytest tests/ -qis not relevant for a docs-only copy change.Documentation & Housekeeping
Non-goals
Residual Risk
The exact field names may need maintainer vocabulary changes. Because this is docs-only and explicitly optional, the safe review path is to adjust naming here before any tests or runtime UI depend on it.