Skip to content

Vermonster/ver-pr-writer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ver-pr-writer

An agent skill for generating reviewer-focused pull request descriptions using explicit PR signals.

Helps both humans and agents answer: what changed, why, where the risk is, how it was validated, what deserves attention, and what still needs judgment.

Why PR signals?

If your team is using AI coding agents, you've probably noticed something: the bottleneck isn't writing code anymore. It's reviewing it. See MOTIVATION.md for the full analysis of why structured PR signals matter in agentic SDLC workflows.

Install

npx skills add Vermonster/ver-pr-writer

Or install to specific agents:

npx skills add Vermonster/ver-pr-writer -a github-copilot
npx skills add Vermonster/ver-pr-writer -a claude-code
npx skills add Vermonster/ver-pr-writer -a cursor

What it does

When activated, the skill:

  1. Inspects the git diff, changed files, commit messages, tests, and other available context
  2. Classifies the change type, scope, and risk
  3. Generates a structured PR description covering intent, mental model, risk signals, evidence, review targeting, operations, and uncertainty
  4. Validates the generated signals against the actual diff and fixes mismatches

Usage

The skill has two modes: draft and submit.

Draft mode (default)

Generates the PR description and displays it without touching GitHub. Use this to review and iterate before submitting.

"Write a PR description for this branch"

"Draft PR signals for my changes"

"Generate a PR description"

Submit mode

Generates the PR description, then creates or updates the pull request on GitHub. The skill checks for an existing PR on the current branch and either creates a new one or updates the body.

"Submit a PR for this branch"

"Create a PR with signals"

"Update my PR description"

Submit mode uses the GitHub Pull Request tool when available, and falls back to gh CLI. New PRs are created as drafts by default.

The skill will always confirm before creating a new PR, and show a summary before updating an existing one.

Note: If your changes include UI updates, the skill will prompt you to add screenshots or a short screencast after the PR is created.

What's included

File Purpose
skills/ver-pr-writer/SKILL.md Agent instructions for generating and validating PR descriptions
skills/ver-pr-writer/reference/template.md Output template the agent follows
skills/ver-pr-writer/reference/pr-signals.md Team-facing explanation of PR signals
skills/ver-pr-writer/reference/pr-template.md GitHub PR template teams can adopt
skills/ver-pr-writer/reference/pr-signal-check.yml CI workflow to enforce required sections

Adopting PR signals in your project

To enforce the signal structure on your team's PRs:

  1. Copy reference/pr-template.md to .github/pull_request_template.md in your repo
  2. Copy reference/pr-signal-check.yml to .github/workflows/pr-signal-check.yml
  3. Install the skill so your coding agents generate signal-compliant PR descriptions

Goals

  • Avoid rubber-stamp review
  • Help humans and agents focus on what matters
  • Shift review from raw diff reading toward intent, risk, evidence, and deployability
  • Create a shared signal contract for PR authors, reviewers, and tooling

License

MIT

About

An agent skill for generating reviewer-focused pull request descriptions using explicit PR signals.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors