gh-pr-metadata

Normalize GitHub Pull Request titles to conventional commit format and rewrite bodies to match repository templates.

2.6k|423|Updated Oct 24, 2020
One-click install
npx skills add https://github.com/module-federation/core --skill gh-pr-metadata
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gh-pr-metadata
Source: https://github.com/module-federation/core/tree/main/.codex/skills/gh-pr-metadata
Command: npx skills add https://github.com/module-federation/core --skill gh-pr-metadata

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures your GitHub Pull Request titles and bodies adhere to the repository's established conventions, including conventional commit formatting and a standardized PR template.

Core Features & Use Cases

  • Automated PR Metadata Correction: Automatically rewrites PR titles to follow the type(scope): summary format and ensures the PR body includes all required sections and checklist items as defined in the repository's pull request template.
  • Validation: Verifies that the PR metadata is compliant before submission or merge.
  • Use Case: When you create a PR with a vague title like "Update files" or forget to fill out sections of the PR body, this Skill can automatically fix it to meet project standards.

Quick Start

Use the gh-pr-metadata skill to update the current PR's title and body to match the repository's conventions.

Frequently Asked Questions about gh-pr-metadata

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

FAQPage Schema
How do I normalize GitHub pull request titles to conventional commit format?

Yes, you can automatically rewrite PR bodies to match repository-specific templates using this Skill. It validates PR metadata against defined formats and checklist items, ensuring all required sections are present and compliant for improved code review integration.

How does PR metadata validation improve CI/CD integration?

PR metadata validation improves CI/CD integration by ensuring pull request titles and bodies adhere to defined conventional commit formats and repository templates before triggering pipelines. This standardization prevents malformed commits from disrupting automated deployment and code review workflows.

Do I need the gh CLI installed to automate pull request metadata correction?

Yes, you need the gh CLI installed because the Skill depends on it to interact with GitHub. It leverages the gh tool to automatically correct PR titles and bodies, validating them against repository-specific conventions for code review and CI/CD automation.

What's the best way to enforce conventional commits on pull requests?

The best way to enforce conventional commits on pull requests is automating metadata correction to rewrite titles into `type(scope): summary` format and validating PR bodies against repository templates. This standardization ensures consistent code review and CI/CD integration across all contributions.

What happens if my pull request body is missing required checklist items?

If your pull request body is missing required checklist items, this Skill identifies the gaps during metadata validation. It supports automated correction to rewrite the PR body, ensuring it includes all required sections and checklist items defined in your repository's pull request template.