create-handoff

Create Handoff

You are tasked with writing a handoff document to hand off your work to another agent in a new session. You will create a handoff document that is thorough, but also concise. The goal is to compact and summarize your context without losing any of the key details of what you're working on.

Process

1. Filepath & Metadata

Use the following information to understand how to create your document: - Create your file under flow/handoffs/gh-<id>/YYYY-MM-DD_HH-MM-SS_description.md, where: - gh-<id> uses the tracker work-item id (use general if no tracker reference). The literal gh- prefix is a stable filename convention across the repo regardless of which tracker the project uses. - YYYY-MM-DD is today's date - HH-MM-SS is the hours, minutes and seconds based on the current time, in 24-hour format - description is a brief kebab-case description - Gather metadata using git commands: - git rev-parse HEAD for commit hash - git branch --show-current for branch name - git remote get-url origin for repository - Examples: - With a tracker work item: flow/handoffs/gh-123/2025-01-08_13-55-22_implement-streaming-api.md - Without a tracker reference: flow/handoffs/general/2025-01-08_13-55-22_refactor-config.md

2. Handoff writing

Using the above conventions, write your document. Use the defined filepath and the following YAML frontmatter pattern:

---
github_issue: <number or null if no issue>
date: [Current date and time with timezone in ISO format]
git_commit: [Current commit hash]
branch: [Current branch name]
repository: [Repository name]
topic: "[Feature/Task Name]"
tags: [handoff, relevant-component-names]
status: complete
---

# Handoff: <description>

## Task(s)
{description of the task(s) that you were working on, along with the status of each (completed, work in progress, planned/discussed). If you are working on an implementation plan, make sure to call out which phase you are on. Make sure to reference the plan document and/or research document(s) you are working from that were provided to you at the beginning of the session, if applicable.}

## Critical References
{List any critical specification documents, architectural decisions, or design docs that must be followed. Include only 2-3 most important file paths. Leave blank if none.}

## Recent changes
{describe recent changes made to the codebase that you made in file:line syntax}

## Learnings
{describe important things that you learned - e.g. patterns, root causes of bugs, or other important pieces of information someone that is picking up your work after you should know. consider listing explicit file paths.}

## Artifacts
{an exhaustive list of artifacts you produced or updated as filepaths and/or file:line references - e.g. paths to feature documents, implementation plans, etc that should be read in order to resume your work.}

## Action Items & Next Steps
{a list of action items and next steps for the next agent to accomplish based on your tasks and their statuses}

## Other Notes
{other notes, references, or useful information - e.g. where relevant sections of the codebase are, where relevant documents are, or other important things you learned that you want to pass on but that don't fall into the above categories}

---

3. Save and Confirm

Save the document to the filepath.

Once this is completed, you should respond to the user with:

Handoff created! You can resume from this handoff in a new session with:

/resume-handoff <path/to/handoff.md>

For example:

Handoff created! You can resume from this handoff in a new session with:

/resume-handoff flow/handoffs/gh-123/2025-01-08_13-44-55_implement-streaming-api.md

---

Additional Notes & Instructions

• more information, not less. This is a guideline that defines the minimum of what a handoff should be. Always feel free to include more information if necessary.
• be thorough and precise. include both top-level objectives, and lower-level details as necessary.
• avoid excessive code snippets. While a brief snippet to describe some key change is important, avoid large code blocks or diffs; do not include one unless it's necessary (e.g. pertains to an error you're debugging). Prefer using /path/to/file.ext:line references that an agent can follow later when it's ready.