write-overview

Generates a narrative branch overview from commit history into JSON.

1|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/qmu/workaholic --skill write-overview
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-overview
Source: https://github.com/qmu/workaholic/tree/main/plugins/core/skills/write-overview
Command: npx skills add https://github.com/qmu/workaholic --skill write-overview

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, and includes scripts (resource) components.

What problem does it solve?

This Skill helps teams turn commit histories into concise branch overviews, providing a deterministic narrative of what happened on a feature branch.

Core Features & Use Cases

  • Generate an overview, highlights, motivation, and journey from a branch's commits.
  • Group related commits into meaningful highlights and synthesize rationale and development progression.
  • Use cases include release notes, PR descriptions, and development summaries.

Quick Start

Execute the script to collect commits for a base branch (default main). Example: bash sh/collect-commits.sh [base-branch]

Frequently Asked Questions about write-overview

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a branch overview from git commit history?▼

To generate a branch overview from git commit history, you can run a script that collects commits against a base branch and outputs a deterministic JSON payload containing narrative summaries, highlights, motivation, and journey data.

Can I automate release notes generation from commit subjects and timestamps?▼

Yes, you can automate release notes generation by synthesizing commit subjects, bodies, and timestamps into a structured JSON output that groups related commits into highlights and a development journey.

What is a branch overview and when do I need it for pull requests?▼

A branch overview is a narrative summary of development progression on a feature branch. You need it for pull requests and release notes to provide a concise, deterministic rationale of what happened and why.

Does this branch overview tool work with any git branch?▼

Yes, the branch overview generation applies to any git branch. You need git installed and a base branch specified to collect and group commits into a deterministic JSON summary.

What's the best way to turn commits into actionable highlights for a PR description?▼

The best way to turn commits into actionable highlights is to group related commit subjects and bodies into meaningful development milestones, outputting a JSON payload with overview, highlights, motivation, and journey fields.

Do I need git installed to collect commits for a branch overview?▼

Yes, git is a required dependency to collect commits and generate a branch overview. The script uses git to gather commit subjects, bodies, and timestamps for the deterministic JSON output.