TODO Management - OpenHands Docs

This example is available on GitHub: examples/03_github_workflows/03_todo_management/

Scan your codebase for TODO comments and let the OpenHands Agent implement them, creating a pull request for each TODO and picking relevant reviewers based on code changes and file ownership

Quick Start

# 1. Copy workflow to your repository
cp examples/03_github_workflows/03_todo_management/workflow.yml .github/workflows/todo-management.yml

# 2. Configure secrets in GitHub Settings → Secrets
# Add: LLM_API_KEY

# 3. Configure GitHub Actions permissions
# Settings → Actions → General → Workflow permissions
# Enable: "Read and write permissions" + "Allow GitHub Actions to create and approve pull requests"

# 4. Add TODO comments to your code
# Example: # TODO(openhands): Add input validation for user email

The workflow is configurable and any identifier can be used in place of TODO(openhands)

Features

Scanning - Finds matching TODO comments with configurable identifiers and extracts the TODO description.
Implementation - Sends the TODO description to the OpenHands Agent that automatically implements it
PR Management - Creates feature branches, pull requests and picks most relevant reviewers

Best Practices

Start Small - Begin with MAX_TODOS: 1 to test the workflow
Clear Descriptions - Write descriptive TODO comments
Review PRs - Always review the generated PRs before merging

⌘I