creating-pull-requests

Create pull requests with active-voice titles and structured markdown sections.

Updated Dec 25, 2019
One-click install
npx skills add https://github.com/boga/dotfiles --skill creating-pull-requests-boga
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: creating-pull-requests
Source: https://github.com/boga/dotfiles/tree/main/templates/opencode/skills/creating-pull-requests
Command: npx skills add https://github.com/boga/dotfiles --skill creating-pull-requests-boga

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures your pull requests are clear, concise, and follow best practices, making code reviews more efficient and effective.

Core Features & Use Cases

  • Standardized PR Formatting: Enforces active-voice titles and structured descriptions (Why, Approach, How, Links).
  • Context Gathering: Provides commands to review commits and diffs before creating a PR.
  • Use Case: When submitting a new feature, use this skill to automatically generate a PR title like "Implement user authentication" and a description detailing the motivation, approach, and relevant ticket links.

Quick Start

Use the creating-pull-requests skill to draft a pull request with the title "Add feature X" and a detailed description.

Frequently Asked Questions about creating-pull-requests

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

FAQPage Schema
How do I create a structured pull request description for code review?

This skill standardizes pull request creation by enforcing active-voice titles and structured markdown descriptions including sections for Why, Approach, How it works, and Links. This formatting ensures clarity and completeness of changes for efficient code reviews.

Do I need the gh CLI installed to automate GitHub pull request creation?

Yes, you need the gh CLI installed to use this skill, as it requires the gh CLI for execution to standardize PR creation. The tool facilitates formatting and submitting your structured markdown descriptions directly to GitHub.

What is the best way to format commit messages and PR titles for GitHub?

The best way to format PR titles is by using active voice, such as "Implement user authentication", to ensure clarity. This skill enforces active-voice titles and adherence to best practices for commit messages and PR content.

How do I gather context from commits and diffs before creating a pull request?

You can gather context by using the provided commands to review commits and diffs before creating a pull request. This ensures your structured PR description accurately reflects the motivation and approach of your code modifications.

Can I use this skill to draft a PR for a new feature submission?

Yes, you can use this skill to draft a PR for a new feature submission. It automatically generates an active-voice title like "Add feature X" and a detailed description outlining the motivation, approach, and relevant ticket links.