skills.rest
y-miyazaki
y-miyazakiCOMMUNITY
Explore all skills by this author →
GitHub

github-pr-overview

Update GitHub Pull Request body sections using provided scripts.

4|Updated May 29, 2020
Search Tags:#automation#ci/cd#code review#documentation#pull request#github
One-click install
npx skills add https://github.com/y-miyazaki/go-common --skill github-pr-overview
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: github-pr-overview
Source: https://github.com/y-miyazaki/go-common/tree/main/.github/skills/github-pr-overview
Command: npx skills add https://github.com/y-miyazaki/go-common --skill github-pr-overview

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the population of the ## Overview and ## Changes sections in GitHub Pull Request bodies, ensuring consistency and saving developers time.

Core Features & Use Cases

  • Automated PR Body Updates: Generates structured, informative content for PRs.
  • Change Classification: Categorizes file changes for better readability.
  • Use Case: After pushing new code to a Pull Request, use this Skill to automatically update the PR body with a summary of changes and an overview of the PR's purpose, ensuring reviewers have immediate context.

Quick Start

Use the github-pr-overview skill to update the body of pull request number 123 in the owner/repo repository.

Frequently Asked Questions about github-pr-overview

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

FAQPage Schema
How do I automate GitHub pull request body updates?▼

Automate GitHub pull request body updates by using scripts that analyze PR metadata and file changes to generate structured content for the Overview and Changes sections, preserving the rest of your PR template.

Do I need GitHub CLI to update PR body sections automatically?▼

Yes, you need GitHub CLI installed and configured to update PR body sections automatically, as the automation scripts rely on it to interact with your repository and apply the generated content to the pull request.

How does pull request change classification work for documentation?▼

Pull request change classification works by analyzing file changes in your code and categorizing them to generate structured, readable documentation directly within the PR body for reviewers.

Can I preserve my custom PR template when automating pull request updates?▼

Yes, you can preserve your custom PR template when automating pull request updates because the process specifically targets only the Overview and Changes sections while leaving all other parts of your template intact.

What are the limitations of automating pull request documentation generation?▼

Limitations of automating pull request documentation include strict adherence to PR template structure for optimal results, meaning your template must contain the specific Overview and Changes sections for the scripts to update correctly.

Related Skills

Explore More Software Engineering Skills→
shariqazeemshariqazeem
1

create-pr

Create or update GitHub pull requests from the current branch to main.

Community
Advanced
SuperCorksSuperCorks

address-pr-comments

Fetch GitHub PR reviews via gh CLI and apply latest reviewer feedback.

Community
Advanced
ascerra-fullsend-rehearsalascerra-fullsend-rehearsal

code-review

Analyze code changes for correctness, security, intent, style, and documentation compliance.

Official
Advanced
bcastelinobcastelino
2

github-workflow-automation

Automate GitHub workflows for PR reviews, issue triage, and CI/CD pipelines.

Community
Advanced